@getopenpay/client
Version:
OpenPay API TypeScript SDK
148 lines (147 loc) • 6.89 kB
TypeScript
/**
* OpenPay API
* super charge your subscription management.
*
* The version of the OpenAPI document: 1.2.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { AddCommentRequest, CreateInvoiceRequest, InvoiceExternal, InvoicePublic, InvoiceQueryParams, ListResponseInvoiceExternal, MarkUncollectibleRequest, MarkVoidRequest, PayInvoiceRequest, UpdateInvoiceRequest } from '../models/index';
export interface AddCommentOperationRequest {
invoiceExternalId: string;
addCommentRequest: AddCommentRequest;
}
export interface CreateInvoiceOperationRequest {
createInvoiceRequest: CreateInvoiceRequest;
}
export interface FinalizeInvoiceRequest {
invoiceExternalId: string;
}
export interface GetInvoiceRequest {
invoiceExternalId: string;
expand?: Array<string>;
}
export interface GetInvoicePublicRequest {
publicPermanentToken: string;
}
export interface ListInvoicesRequest {
invoiceQueryParams: InvoiceQueryParams;
}
export interface MarkInvoiceAsUncollectibleRequest {
invoiceExternalId: string;
markUncollectibleRequest: MarkUncollectibleRequest;
}
export interface MarkInvoiceAsVoidRequest {
invoiceExternalId: string;
markVoidRequest: MarkVoidRequest;
}
export interface PayInvoiceOperationRequest {
invoiceExternalId: string;
payInvoiceRequest: PayInvoiceRequest;
}
export interface PreviewNextInvoiceRequest {
subscriptionId: string;
}
export interface UpdateInvoiceOperationRequest {
invoiceId: string;
updateInvoiceRequest: UpdateInvoiceRequest;
}
/**
*
*/
export declare class InvoicesApi extends runtime.BaseAPI {
/**
* Add Comment
*/
addCommentRaw(requestParameters: AddCommentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Add Comment
*/
addComment(requestParameters: AddCommentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* This endpoint creates a draft invoice for a given subscription. The invoice remains a draft until you finalize the invoice. The created invoice will only include floating invoice items for a subscription. The subscription’s billing cycle and regular subscription events won’t be affected.
* Create Invoice
*/
createInvoiceRaw(requestParameters: CreateInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* This endpoint creates a draft invoice for a given subscription. The invoice remains a draft until you finalize the invoice. The created invoice will only include floating invoice items for a subscription. The subscription’s billing cycle and regular subscription events won’t be affected.
* Create Invoice
*/
createInvoice(requestParameters: CreateInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Finalize Invoice
*/
finalizeInvoiceRaw(requestParameters: FinalizeInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Finalize Invoice
*/
finalizeInvoice(requestParameters: FinalizeInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Get Invoice
*/
getInvoiceRaw(requestParameters: GetInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Get Invoice
*/
getInvoice(requestParameters: GetInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Get Invoice Public
*/
getInvoicePublicRaw(requestParameters: GetInvoicePublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoicePublic>>;
/**
* Get Invoice Public
*/
getInvoicePublic(requestParameters: GetInvoicePublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoicePublic>;
/**
* List Invoices
*/
listInvoicesRaw(requestParameters: ListInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseInvoiceExternal>>;
/**
* List Invoices
*/
listInvoices(requestParameters: ListInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseInvoiceExternal>;
/**
* Mark Invoice As Uncollectible
*/
markInvoiceAsUncollectibleRaw(requestParameters: MarkInvoiceAsUncollectibleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Mark Invoice As Uncollectible
*/
markInvoiceAsUncollectible(requestParameters: MarkInvoiceAsUncollectibleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Mark Invoice As Void
*/
markInvoiceAsVoidRaw(requestParameters: MarkInvoiceAsVoidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Mark Invoice As Void
*/
markInvoiceAsVoid(requestParameters: MarkInvoiceAsVoidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Pay Invoice
*/
payInvoiceRaw(requestParameters: PayInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Pay Invoice
*/
payInvoice(requestParameters: PayInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Preview Next Invoice
*/
previewNextInvoiceRaw(requestParameters: PreviewNextInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Preview Next Invoice
*/
previewNextInvoice(requestParameters: PreviewNextInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
/**
* Update Invoice
*/
updateInvoiceRaw(requestParameters: UpdateInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceExternal>>;
/**
* Update Invoice
*/
updateInvoice(requestParameters: UpdateInvoiceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceExternal>;
}