Class OAuthClient

Index

Constructors

Methods

createCustomOAuthAppIntegration createPublishedOAuthAppIntegration deleteCustomOAuthAppIntegration deletePublishedOAuthAppIntegration getCustomOAuthAppIntegration getPublishedOAuthAppIntegration listCustomOAuthAppIntegrations listCustomOAuthAppIntegrationsIter listPublishedOAuthAppIntegrations listPublishedOAuthAppIntegrationsIter listPublishedOAuthApps listPublishedOAuthAppsIter updateCustomOAuthAppIntegration updatePublishedOAuthAppIntegration

Constructors

constructor

new OAuthClient(options: ClientOptions): OAuthClient
Parameters
- options: ClientOptions
Returns OAuthClient
- Defined in client.ts:80

Methods

createCustomOAuthAppIntegration

createCustomOAuthAppIntegration(
req: CreateCustomOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<CustomOAuthAppIntegrationSecret>
Create Custom OAuth App Integration.

You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.
Parameters
- req: CreateCustomOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<CustomOAuthAppIntegrationSecret>
- Defined in client.ts:100

createPublishedOAuthAppIntegration

createPublishedOAuthAppIntegration(
req: CreatePublishedOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<CreatePublishedOAuthAppIntegrationResponse>
Create Published OAuth App Integration.

You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.
Parameters
- req: CreatePublishedOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<CreatePublishedOAuthAppIntegrationResponse>
- Defined in client.ts:137

deleteCustomOAuthAppIntegration

deleteCustomOAuthAppIntegration(
req: DeleteCustomOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<DeleteCustomOAuthAppIntegrationResponse>
Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.
Parameters
- req: DeleteCustomOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteCustomOAuthAppIntegrationResponse>
- Defined in client.ts:173

deletePublishedOAuthAppIntegration

deletePublishedOAuthAppIntegration(
req: DeletePublishedOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<DeletePublishedOAuthAppIntegrationResponse>
Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.
Parameters
- req: DeletePublishedOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<DeletePublishedOAuthAppIntegrationResponse>
- Defined in client.ts:205

getCustomOAuthAppIntegration

getCustomOAuthAppIntegration(
req: GetCustomOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<CustomOAuthAppIntegration>
Gets the Custom OAuth App Integration for the given integration id.
Parameters
- req: GetCustomOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<CustomOAuthAppIntegration>
- Defined in client.ts:234

getPublishedOAuthAppIntegration

getPublishedOAuthAppIntegration(
req: GetPublishedOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<PublishedOAuthAppIntegration>
Gets the Published OAuth App Integration for the given integration id.
Parameters
- req: GetPublishedOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<PublishedOAuthAppIntegration>
- Defined in client.ts:260

listCustomOAuthAppIntegrations

listCustomOAuthAppIntegrations(
req: ListCustomOAuthAppIntegrationsRequest,
options?: CallOptions,
): Promise<ListCustomOAuthAppIntegrationsResponse>
Get the list of custom OAuth app integrations for the specified
Parameters
- req: ListCustomOAuthAppIntegrationsRequest
- Optionaloptions: CallOptions
Returns Promise<ListCustomOAuthAppIntegrationsResponse>
- Defined in client.ts:289

listCustomOAuthAppIntegrationsIter

listCustomOAuthAppIntegrationsIter(
req: ListCustomOAuthAppIntegrationsRequest,
options?: CallOptions,
): AsyncGenerator<CustomOAuthAppIntegration>
Parameters
- req: ListCustomOAuthAppIntegrationsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<CustomOAuthAppIntegration>
- Defined in client.ts:332

listPublishedOAuthAppIntegrations

listPublishedOAuthAppIntegrations(
req: ListPublishedOAuthAppIntegrationsRequest,
options?: CallOptions,
): Promise<ListPublishedOAuthAppIntegrationsResponse>
Get the list of published OAuth app integrations for the specified
Parameters
- req: ListPublishedOAuthAppIntegrationsRequest
- Optionaloptions: CallOptions
Returns Promise<ListPublishedOAuthAppIntegrationsResponse>
- Defined in client.ts:350

listPublishedOAuthAppIntegrationsIter

listPublishedOAuthAppIntegrationsIter(
req: ListPublishedOAuthAppIntegrationsRequest,
options?: CallOptions,
): AsyncGenerator<PublishedOAuthAppIntegration>
Parameters
- req: ListPublishedOAuthAppIntegrationsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<PublishedOAuthAppIntegration>
- Defined in client.ts:387

listPublishedOAuthApps

listPublishedOAuthApps(
req: ListPublishedOAuthAppsRequest,
options?: CallOptions,
): Promise<ListPublishedOAuthAppsResponse>
Get all the available published OAuth apps in .
Parameters
- req: ListPublishedOAuthAppsRequest
- Optionaloptions: CallOptions
Returns Promise<ListPublishedOAuthAppsResponse>
- Defined in client.ts:408

listPublishedOAuthAppsIter

listPublishedOAuthAppsIter(
req: ListPublishedOAuthAppsRequest,
options?: CallOptions,
): AsyncGenerator<PublishedOAuthApp>
Parameters
- req: ListPublishedOAuthAppsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<PublishedOAuthApp>
- Defined in client.ts:445

updateCustomOAuthAppIntegration

updateCustomOAuthAppIntegration(
req: UpdateCustomOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<UpdateCustomOAuthAppIntegrationResponse>
Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.
Parameters
- req: UpdateCustomOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateCustomOAuthAppIntegrationResponse>
- Defined in client.ts:466

updatePublishedOAuthAppIntegration

updatePublishedOAuthAppIntegration(
req: UpdatePublishedOAuthAppIntegrationRequest,
options?: CallOptions,
): Promise<UpdatePublishedOAuthAppIntegrationResponse>
Updates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.
Parameters
- req: UpdatePublishedOAuthAppIntegrationRequest
- Optionaloptions: CallOptions
Returns Promise<UpdatePublishedOAuthAppIntegrationResponse>
- Defined in client.ts:502

Class OAuthClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OAuthClient

Methods

createCustomOAuthAppIntegration

Parameters

Returns Promise<CustomOAuthAppIntegrationSecret>

createPublishedOAuthAppIntegration

Parameters

Returns Promise<CreatePublishedOAuthAppIntegrationResponse>

deleteCustomOAuthAppIntegration

Parameters

Returns Promise<DeleteCustomOAuthAppIntegrationResponse>

deletePublishedOAuthAppIntegration

Parameters

Returns Promise<DeletePublishedOAuthAppIntegrationResponse>

getCustomOAuthAppIntegration

Parameters

Returns Promise<CustomOAuthAppIntegration>

getPublishedOAuthAppIntegration

Parameters

Returns Promise<PublishedOAuthAppIntegration>

listCustomOAuthAppIntegrations

Parameters

Returns Promise<ListCustomOAuthAppIntegrationsResponse>

listCustomOAuthAppIntegrationsIter

Parameters

Returns AsyncGenerator<CustomOAuthAppIntegration>

listPublishedOAuthAppIntegrations

Parameters

Returns Promise<ListPublishedOAuthAppIntegrationsResponse>

listPublishedOAuthAppIntegrationsIter

Parameters

Returns AsyncGenerator<PublishedOAuthAppIntegration>

listPublishedOAuthApps

Parameters

Returns Promise<ListPublishedOAuthAppsResponse>

listPublishedOAuthAppsIter

Parameters

Returns AsyncGenerator<PublishedOAuthApp>

updateCustomOAuthAppIntegration

Parameters

Returns Promise<UpdateCustomOAuthAppIntegrationResponse>

updatePublishedOAuthAppIntegration

Parameters

Returns Promise<UpdatePublishedOAuthAppIntegrationResponse>

Settings

On This Page