ordercloud-javascript-sdk
Version:
The offical Javascript SDK for the Ordercloud ecommerce API
101 lines (100 loc) • 6.5 kB
TypeScript
import { ListPage } from '../models/ListPage';
import { Searchable } from '../models/Searchable';
import { Sortable } from '../models/Sortable';
import { Filters } from '../models/Filters';
import { Webhook } from '../models/Webhook';
import { PartialDeep } from '../models/PartialDeep';
import { RequiredDeep } from '../models/RequiredDeep';
import { RequestOptions } from '../models/RequestOptions';
declare class Webhooks {
private impersonating;
/**
* @ignore
* not part of public api, don't include in generated docs
*/
constructor();
/**
* List webhooks
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/list|api docs} for more info
*
* @param listOptions.search Word or phrase to search for.
* @param listOptions.searchOn Comma-delimited list of fields to search on.
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
* @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page.
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
List<TWebhook extends Webhook>(listOptions?: {
search?: string;
searchOn?: Searchable<'Webhooks.List'>;
sortBy?: Sortable<'Webhooks.List'>;
page?: number;
pageSize?: number;
filters?: Filters;
}, requestOptions?: RequestOptions): Promise<RequiredDeep<ListPage<TWebhook>>>;
/**
* Create a webhook
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/create|api docs} for more info
*
* @param webhook Required fields: Name
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
Create<TWebhook extends Webhook>(webhook: Webhook, requestOptions?: RequestOptions): Promise<RequiredDeep<TWebhook>>;
/**
* Retrieve a webhook
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/get|api docs} for more info
*
* @param webhookID ID of the webhook.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
Get<TWebhook extends Webhook>(webhookID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TWebhook>>;
/**
* Create or update a webhook If an object with the same ID already exists, it will be overwritten.
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/save|api docs} for more info
*
* @param webhookID ID of the webhook.
* @param webhook Required fields: Name
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
Save<TWebhook extends Webhook>(webhookID: string, webhook: Webhook, requestOptions?: RequestOptions): Promise<RequiredDeep<TWebhook>>;
/**
* Delete a webhook
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/delete|api docs} for more info
*
* @param webhookID ID of the webhook.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
Delete(webhookID: string, requestOptions?: RequestOptions): Promise<void>;
/**
* Partially update a webhook
* Check out the {@link https://ordercloud.io/api-reference/marketplace-owner/webhooks/patch|api docs} for more info
*
* @param webhookID ID of the webhook.
* @param webhook
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
Patch<TWebhook extends Webhook>(webhookID: string, webhook: PartialDeep<Webhook>, requestOptions?: RequestOptions): Promise<RequiredDeep<TWebhook>>;
/**
* @description
* enables impersonation by calling the subsequent method with the stored impersonation token
*
* @example
* Webhooks.As().List() // lists Webhooks using the impersonated users' token
*/
As(): this;
}
declare const _default: Webhooks;
export default _default;