assembly-payments
Version:
Assembly Payments API Typescript/Javascript Bindings
59 lines (58 loc) • 2.13 kB
TypeScript
import { Client } from '../client';
import { ChargeRequestBody, Charges, SingleUser, SingleCharge, SingleChargeStatus } from '../types';
declare const _default: (client: Client) => {
/**
* @description Retrieve an ordered and paginated list of **Charges**.
*
* @tags Charges
* @name ListCharges
* @summary List Charges
* @request GET:/charges
* @secure
*/
listCharges: (params?: {
limit?: number | undefined;
offset?: number | undefined;
} | undefined) => Promise<Charges>;
/**
* @description Create a **Charge**. **Charges** require a specified **Card Account** or **Bank Account**. You may pass through an existing **User**, or define the `user_id` of the new user that will be associated with the **Charge** and the provided Account. The `user_id` can be left blank if you wish for a new user to be created for the **Charge**, or specified if you wish for a new **User** to be created with the passed `user_id`.
*
* @tags Charges
* @name CreateCharge
* @summary Create Charge
* @request POST:/charges
* @secure
*/
createCharge: (data: ChargeRequestBody) => Promise<SingleCharge>;
/**
* @description Show details of a specific **Charge** using a given `:id`.
*
* @tags Charges
* @name ShowCharge
* @summary Show Charge
* @request GET:/charges/{id}
* @secure
*/
showCharge: (id: string) => Promise<SingleCharge>;
/**
* @description Show status of a specific **Charge** using a given `:id`.
*
* @tags Charges
* @name ShowChargeStatus
* @summary Show Charge Status
* @request GET:/charges/{id}/status
* @secure
*/
showChargeStatus: (id: string) => Promise<SingleChargeStatus>;
/**
* @description Show the buyer **User** associated with the **Charge** using a given `:id`.
*
* @tags Charges
* @name ShowChargeBuyer
* @summary Show Charge Buyer
* @request GET:/charges/{id}/buyers
* @secure
*/
showChargeBuyer: (id: string) => Promise<SingleUser>;
};
export default _default;