@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiCallbacksModule
Class: AffiliateApiCallbacksModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiCallbacksModule
A module for interacting with the callbacks endpoint of the Affiliate API.
Since
v1.20240429.0
Methods
all
▸ all(options?): Promise<ResponseFields<AffiliateApiCallbacksModelDefinition>[]>
List all callbacks matching the specified options via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | Omit<ListMethodOptions<AffiliateApiCallbacksModelDefinition>, "limit" | "page"> | The options to use when listing all matching callbacks. |
Returns
Promise<ResponseFields<AffiliateApiCallbacksModelDefinition>[]>
A list of all matching callbacks.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/callbacks.ts:98
list
▸ list(options?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiCallbacksModelDefinition>[], ResponseFields<AffiliateApiCallbacksModelDefinition>[]>>
List callbacks via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | ListMethodOptions<AffiliateApiCallbacksModelDefinition> | The options to use when listing callbacks. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiCallbacksModelDefinition>[], ResponseFields<AffiliateApiCallbacksModelDefinition>[]>>
List of callbacks
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/callbacks.ts:76
update
▸ update(payload): Promise<AffiliateApiOperationResponse<AffiliateApiCallbackSaveSuccessfulResponse, AffiliateApiCallbackSaveSuccessfulResponse>>
Update a callback via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
payload | UpdatePayload<AffiliateApiCallbacksModelDefinition> | The payload for creating a new callback via the Affiliate API. |
Returns
Promise<AffiliateApiOperationResponse<AffiliateApiCallbackSaveSuccessfulResponse, AffiliateApiCallbackSaveSuccessfulResponse>>
Update Status and Resource Information on the updated callback
Throws
AffiliateApiOperationError If the operation was not successful.
Reference