-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ea156db
commit dbd3603
Showing
17 changed files
with
1,488 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| [@chatbotkit/sdk](../README.md) / [Modules](../modules.md) / [platform](../modules/platform.md) / PlatformClient | ||
|
|
||
| # Class: PlatformClient | ||
|
|
||
| [platform](../modules/platform.md).PlatformClient | ||
|
|
||
| Platform client. | ||
|
|
||
| ## Hierarchy | ||
|
|
||
| - [`ChatBotKitClient`](client.ChatBotKitClient.md) | ||
|
|
||
| ↳ **`PlatformClient`** | ||
|
|
||
| ## Table of contents | ||
|
|
||
| ### Constructors | ||
|
|
||
| - [constructor](platform.PlatformClient.md#constructor) | ||
|
|
||
| ### Properties | ||
|
|
||
| - [ability](platform.PlatformClient.md#ability) | ||
| - [secrets](platform.PlatformClient.md#secrets) | ||
| - [user](platform.PlatformClient.md#user) | ||
|
|
||
| ### Methods | ||
|
|
||
| - [clientFetch](platform.PlatformClient.md#clientfetch) | ||
|
|
||
| ## Constructors | ||
|
|
||
| ### constructor | ||
|
|
||
| • **new PlatformClient**(`options`): [`PlatformClient`](platform.PlatformClient.md) | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `options` | [`ChatBotKitClientOptions`](../interfaces/client.ChatBotKitClientOptions.md) | | ||
|
|
||
| #### Returns | ||
|
|
||
| [`PlatformClient`](platform.PlatformClient.md) | ||
|
|
||
| #### Overrides | ||
|
|
||
| [ChatBotKitClient](client.ChatBotKitClient.md).[constructor](client.ChatBotKitClient.md#constructor) | ||
|
|
||
| #### Defined in | ||
|
|
||
| [platform/index.js:13](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/platform/index.js#L13) | ||
|
|
||
| ## Properties | ||
|
|
||
| ### ability | ||
|
|
||
| • **ability**: [`PlatformAbilityClient`](platform_ability.PlatformAbilityClient.md) | ||
|
|
||
| #### Defined in | ||
|
|
||
| [platform/index.js:24](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/platform/index.js#L24) | ||
|
|
||
| ___ | ||
|
|
||
| ### secrets | ||
|
|
||
| • **secrets**: [`PlatformSecretClient`](platform_secret.PlatformSecretClient.md) | ||
|
|
||
| **`Note`** | ||
|
|
||
| overlapping name with the `secret` property | ||
|
|
||
| #### Defined in | ||
|
|
||
| [platform/index.js:30](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/platform/index.js#L30) | ||
|
|
||
| ___ | ||
|
|
||
| ### user | ||
|
|
||
| • **user**: [`PlatformModelClient`](platform_model.PlatformModelClient.md) | ||
|
|
||
| #### Defined in | ||
|
|
||
| [platform/index.js:19](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/platform/index.js#L19) | ||
|
|
||
| ## Methods | ||
|
|
||
| ### clientFetch | ||
|
|
||
| ▸ **clientFetch**\<`T`, `U`\>(`path`, `options?`): [`ResponsePromise`](client.ResponsePromise.md)\<`T`, `U`\> | ||
|
|
||
| #### Type parameters | ||
|
|
||
| | Name | | ||
| | :------ | | ||
| | `T` | | ||
| | `U` | | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `path` | `string` | | ||
| | `options?` | `Object` | | ||
| | `options.buffer?` | [`ArrayBuffer`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ) | | ||
| | `options.endpoint?` | `string` | | ||
| | `options.external?` | `boolean` | | ||
| | `options.file?` | `Object` | | ||
| | `options.file.data` | `string` \| [`ArrayBuffer`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ) | | ||
| | `options.file.name?` | `string` | | ||
| | `options.file.type?` | `string` | | ||
| | `options.headers?` | [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `any`\> | | ||
| | `options.method?` | `string` | | ||
| | `options.query?` | [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `any`\> | | ||
| | `options.record?` | [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )\<`string`, `any`\> | | ||
|
|
||
| #### Returns | ||
|
|
||
| [`ResponsePromise`](client.ResponsePromise.md)\<`T`, `U`\> | ||
|
|
||
| #### Inherited from | ||
|
|
||
| [ChatBotKitClient](client.ChatBotKitClient.md).[clientFetch](client.ChatBotKitClient.md#clientfetch) | ||
|
|
||
| #### Defined in | ||
|
|
||
| [client.js:222](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/client.js#L222) |
Oops, something went wrong.