@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';
import { CreateOrUpdateEndpointRequest } from '../models/createOrUpdateEndpointRequest';
import { EnableWebhooksRequest } from '../models/enableWebhooksRequest';
import { EnableWebhooksResponse } from '../models/enableWebhooksResponse';
import { Endpoint } from '../models/endpoint';
import { EndpointResponse } from '../models/endpointResponse';
import { ReplayWebhooksRequest } from '../models/replayWebhooksRequest';
import { ReplayWebhooksResponse } from '../models/replayWebhooksResponse';
import { WebhookOrder } from '../models/webhookOrder';
import { WebhookResponse } from '../models/webhookResponse';
import { WebhookStatus } from '../models/webhookStatus';
import { BaseController } from './baseController';
export declare class WebhooksController extends BaseController {
    /**
     * ## Webhooks Intro
     *
     * The Webhooks API allows you to view a list of all webhooks and to selectively resend individual or
     * groups of webhooks. Webhooks will be sent on endpoints specified by you. Endpoints can be added via
     * API or Web UI. There is also an option to enable / disable webhooks via API request.
     *
     * We recommend that you review Advanced Billing's webhook documentation located in our help site. The
     * following resources will help guide you on how to use webhooks in Advanced Billing, in addition to
     * these webhook endpoints:
     *
     * + [Adding/editing new webhooks](https://maxio.zendesk.com/hc/en-us/articles/24286723085197-
     * Webhooks#configure-webhook-url)
     * + [Webhooks introduction and delivery information](https://maxio.zendesk.com/hc/en-
     * us/articles/24266143173901-Webhooks-Overview)
     * + [Main webhook reference](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
     * Reference)
     * + [Available webhooks and payloads](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-
     * Webhooks-Reference#events)
     *
     * ## List Webhooks for a Site
     *
     * This method allows you to fetch data about webhooks. You can pass query parameters if you want to
     * filter webhooks.
     *
     * @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[]>>;
    /**
     * This method allows you to enable webhooks via API for your site
     *
     * @param body
     * @return Response from the API call
     */
    enableWebhooks(body?: EnableWebhooksRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EnableWebhooksResponse>>;
    /**
     * Posting to the replay endpoint does not immediately resend the webhooks. They are added to a queue
     * and will be sent as soon as possible, depending on available system resources.
     *
     * You may submit an array of up to 1000 webhook IDs to replay in the request.
     *
     * @param body
     * @return Response from the API call
     */
    replayWebhooks(body?: ReplayWebhooksRequest, requestOptions?: RequestOptions): Promise<ApiResponse<ReplayWebhooksResponse>>;
    /**
     * The Chargify API allows you to create an endpoint and assign a list of webhooks subscriptions
     * (events) to it.
     *
     * You can check available events here.
     * [Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-Reference#events)
     *
     * @param body
     * @return Response from the API call
     */
    createEndpoint(body?: CreateOrUpdateEndpointRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EndpointResponse>>;
    /**
     * This method returns created endpoints for site.
     *
     * @return Response from the API call
     */
    listEndpoints(requestOptions?: RequestOptions): Promise<ApiResponse<Endpoint[]>>;
    /**
     * You can update an Endpoint via the API with a PUT request to the resource endpoint.
     *
     * You can change the `url` of your endpoint which consumes webhooks or list of `webhook_subscriptions`.
     * Check available [Event keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
     * Reference#events).
     *
     * Always send a complete list of events which you want subscribe/watch.
     * Sending an PUT request for existing endpoint with empty list of `webhook_subscriptions` will end
     * with unsubscribe from all events.
     *
     * If you want unsubscribe from specific event, just 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