Class: module:api/TokensApiApi

module:api/TokensApiApi(apiClient)

new module:api/TokensApiApi(apiClient)

Constructs a new TokensApiApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

CreateToken(token, opts, oauth2client, credentials)

Add a new Webhook secret token.

Parameters:
Name Type Description
token String

A secret token that is used to generate a hash signature, which is passed along with notification requests to the callback URL
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

DeleteToken(opts, oauth2client, credentials)

Delete a Webhook secret token

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

UpdateToken(token, opts, oauth2client, credentials)

Update an existing Webhook secret token

Parameters:
Name Type Description
token String

A secret token that is used to generate a hash signature, which is passed along with notification requests to the callback URL
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: