import { GetTeamWebhooks200Response } from '../../models/base/get-team-webhooks200-response/index'; import { GetWebhookRequests200Response } from '../../models/base/get-webhook-requests200-response/index'; import { PostWebhookRequest } from '../../models/base/post-webhook-request/index'; import { PutWebhookRequest } from '../../models/base/put-webhook-request/index'; import { WebhookV2 } from '../../models/base/webhook-v2/index'; import { Api, ApiClient, RequestMetadata } from '@ama-sdk/core'; /** Parameters object to WebhooksApi's deleteWebhook function */ export interface WebhooksApiDeleteWebhookRequestData { /** ID of webhook to delete */ 'webhook_id': string; } /** Parameters object to WebhooksApi's getTeamWebhooks function */ export interface WebhooksApiGetTeamWebhooksRequestData { /** ID of team to get webhooks for */ 'team_id': string; } /** Parameters object to WebhooksApi's getWebhook function */ export interface WebhooksApiGetWebhookRequestData { /** ID of webhook to get */ 'webhook_id': string; } /** Parameters object to WebhooksApi's getWebhookRequests function */ export interface WebhooksApiGetWebhookRequestsRequestData { /** The id of the webhook subscription you want to see events from */ 'webhook_id': string; } /** Parameters object to WebhooksApi's postWebhook function */ export interface WebhooksApiPostWebhookRequestData { /** The webhook to create. */ 'PostWebhookRequest': PostWebhookRequest; } /** Parameters object to WebhooksApi's putWebhook function */ export interface WebhooksApiPutWebhookRequestData { /** ID of webhook to update */ 'webhook_id': string; /** The webhook to update. */ 'PutWebhookRequest': PutWebhookRequest; } export declare class WebhooksApi implements Api { /** API name */ static readonly apiName = "WebhooksApi"; /** @inheritDoc */ readonly apiName = "WebhooksApi"; /** Tokens of the parameters containing PII */ readonly piiParamTokens: { [key: string]: string; }; /** @inheritDoc */ client: ApiClient; /** * Initialize your interface * * @param apiClient Client used to process call to the API */ constructor(apiClient: ApiClient); /** * Delete a webhook * Deletes the specified webhook. This operation cannot be reversed. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ deleteWebhook(data: WebhooksApiDeleteWebhookRequestData, metadata?: RequestMetadata): Promise; /** * Get team webhooks * Returns all webhooks registered under the specified team. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getTeamWebhooks(data: WebhooksApiGetTeamWebhooksRequestData, metadata?: RequestMetadata): Promise; /** * Get a webhook * Get a webhook by ID. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getWebhook(data: WebhooksApiGetWebhookRequestData, metadata?: RequestMetadata): Promise; /** * Get webhook requests * Returns all webhook requests sent within the last week. Useful for debugging. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getWebhookRequests(data: WebhooksApiGetWebhookRequestsRequestData, metadata?: RequestMetadata): Promise; /** * Create a webhook * Create a new webhook which will call the specified endpoint when the event triggers. By default, this webhook will automatically send a PING event to the endpoint when it is created. If this behavior is not desired, you can create the webhook and set the status to PAUSED and reactivate it later. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ postWebhook(data: WebhooksApiPostWebhookRequestData, metadata?: RequestMetadata<'application/json', 'application/json'>): Promise; /** * Update a webhook * Update a webhook by ID. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ putWebhook(data: WebhooksApiPutWebhookRequestData, metadata?: RequestMetadata<'application/json', 'application/json'>): Promise; } //# sourceMappingURL=webhooks-api.d.ts.map