assembly-payments/lib/resources/callbacks.d.ts

Assembly Payments API Typescript/Javascript Bindings

import { Client } from '../client';
import { SingleCallback, CallbackDeletion, ListCallbackResponses, CallbackRequestBody, SingleCallbackResponse, Callbacks } from '../types';
declare const _default: (client: Client) => {
    /**
     * @description Show details of a specific **Callback** using a given `:id`.
     *
     * @tags Callbacks
     * @name ShowCallback
     * @summary Show Callback
     * @request GET:/callbacks/{id}
     * @secure
     */
    showCallback: (id: string) => Promise<SingleCallback>;
    /**
     * @description Delete an existing Callback using a given `:id`.
     *
     * @tags Callbacks
     * @name DeleteCallback
     * @summary Delete Callback
     * @request DELETE:/callbacks/{id}
     * @secure
     */
    deleteCallback: (id: string) => Promise<CallbackDeletion>;
    /**
     * @description Update an existing **Callback** using a given `:id`. You can change the `URL`, the `object_type` and whether the **Callback** is `enabled` or `disabled`.
     *
     * @tags Callbacks
     * @name UpdateCallback
     * @summary Update Callback
     * @request PATCH:/callbacks/{id}
     * @secure
     */
    updateCallback: (id: string, data: CallbackRequestBody) => Promise<SingleCallback>;
    /**
     * @description Retrieve an ordered and paginated list of the responses garnered from a callback using a given `:id`.
     *
     * @tags Callbacks
     * @name ListCallbackResponse
     * @summary List Callback Responses
     * @request GET:/callbacks/{id}/responses
     * @secure
     */
    listCallbackResponse: (id: string, params?: {
        limit?: number | undefined;
        offset?: number | undefined;
    } | undefined) => Promise<ListCallbackResponses>;
    /**
     * @description Show details of a specific **Callback** response using a given `:id`.
     *
     * @tags Callbacks
     * @name ShowCallbackResponse
     * @summary Show Callback Response
     * @request GET:/callbacks/{callback_id}/responses/{id}
     * @secure
     */
    showCallbackResponse: (callbackId: string, id: string) => Promise<SingleCallbackResponse>;
    /**
     * @description Retrieve an ordered and paginated list of all created **Callbacks**.
     *
     * @tags Callbacks
     * @name ListCallbacks
     * @summary List Callbacks
     * @request GET:/callbacks
     * @secure
     */
    listCallbacks: (params?: {
        limit?: number | undefined;
        offset?: number | undefined;
        filter?: string | undefined;
    } | undefined) => Promise<Callbacks>;
    /**
     * @description Create a **Callback** to notify you at the `URL` when the `object_type` changes
     *
     * @tags Callbacks
     * @name CreateCallback
     * @summary Create Callback
     * @request POST:/callbacks
     * @secure
     */
    createCallback: (data: CallbackRequestBody) => Promise<SingleCallback>;
};
export default _default;