@maxio-com/advanced-billing-sdk/dist/types/controllers/webhooksController.d.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */
import { ApiResponse, RequestOptions } from '../core.js';
import { CreateOrUpdateEndpointRequest } from '../models/createOrUpdateEndpointRequest.js';
import { EnableWebhooksRequest } from '../models/enableWebhooksRequest.js';
import { EnableWebhooksResponse } from '../models/enableWebhooksResponse.js';
import { Endpoint } from '../models/endpoint.js';
import { EndpointResponse } from '../models/endpointResponse.js';
import { ReplayWebhooksRequest } from '../models/replayWebhooksRequest.js';
import { ReplayWebhooksResponse } from '../models/replayWebhooksResponse.js';
import { WebhookOrder } from '../models/webhookOrder.js';
import { WebhookResponse } from '../models/webhookResponse.js';
import { WebhookStatus } from '../models/webhookStatus.js';
import { BaseController } from './baseController.js';
export declare class WebhooksController extends BaseController {
    /**
     * Allows you to view a list of webhooks.  You can pass query parameters if you want to filter webhooks.
     * See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information.
     *
     * @param status       Webhooks with matching status would be returned.
     * @param sinceDate    Format YYYY-MM-DD. Returns Webhooks with the created_at date greater than or
     *                                      equal to the one specified.
     * @param untilDate    Format YYYY-MM-DD. Returns Webhooks with the created_at date less than or
     *                                      equal to the one specified.
     * @param page         Result records are organized in pages. By default, the first page of results
     *                                      is displayed. The page parameter specifies a page number of results to fetch.
     *                                      You can start navigating through the pages to consume the results. You do
     *                                      this by passing in a page parameter. Retrieve the next page by adding ?page=2
     *                                      to the query string. If there are no results to return, then an empty result
     *                                      set will be returned. Use in query `page=1`.
     * @param perPage      This parameter indicates how many records to fetch in each request. Default
     *                                      value is 20. The maximum allowed values is 200; any per_page value over 200
     *                                      will be changed to 200. Use in query `per_page=200`.
     * @param order        The order in which the Webhooks are returned.
     * @param subscription The Advanced Billing id of a subscription you'd like to filter for
     * @return Response from the API call
     */
    listWebhooks({ status, sinceDate, untilDate, page, perPage, order, subscription, }: {
        status?: WebhookStatus;
        sinceDate?: string;
        untilDate?: string;
        page?: number;
        perPage?: number;
        order?: WebhookOrder;
        subscription?: number;
    }, requestOptions?: RequestOptions): Promise<ApiResponse<WebhookResponse[]>>;
    /**
     * Allows you to enable webhooks for your site
     *
     * @param body
     * @return Response from the API call
     */
    enableWebhooks(body?: EnableWebhooksRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EnableWebhooksResponse>>;
    /**
     * Replays webhooks. Posting to this endpoint does not immediately resend the webhooks. They are added
     * to a queue and sent as soon as possible, depending on available system resources. You can submit an
     * array of up to 1000 webhook IDs in the replay request.
     *
     * @param body
     * @return Response from the API call
     */
    replayWebhooks(body?: ReplayWebhooksRequest, requestOptions?: RequestOptions): Promise<ApiResponse<ReplayWebhooksResponse>>;
    /**
     * Creates an endpoint and assigns a list of webhooks subscriptions (events) to it.
     * See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for
     * available events.
     *
     * @param body
     * @return Response from the API call
     */
    createEndpoint(body?: CreateOrUpdateEndpointRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EndpointResponse>>;
    /**
     * Returns created endpoints for a site.
     *
     * @return Response from the API call
     */
    listEndpoints(requestOptions?: RequestOptions): Promise<ApiResponse<Endpoint[]>>;
    /**
     * Updates an Endpoint. You can change the `url` of your endpoint or the list of
     * `webhook_subscriptions` to which you are subscribed. See the [Webhooks Reference](page:
     * introduction/webhooks/webhooks-reference#events) page for available events.
     *
     * Always send a complete list of events to which you want to subscribe. Sending a PUT request for an
     * existing endpoint with an empty list of `webhook_subscriptions` will unsubscribe all events.
     *
     * If you want unsubscribe from a specific event, send a list of `webhook_subscriptions` without the
     * specific event key.
     *
     * @param endpointId   The Advanced Billing id for the endpoint that should
     *                                                             be updated
     * @param body
     * @return Response from the API call
     */
    updateEndpoint(endpointId: number, body?: CreateOrUpdateEndpointRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EndpointResponse>>;
}
//# sourceMappingURL=webhooksController.d.ts.map