@pollination-solutions/pollination-sdk 1.7.3 → 1.8.1

package/dist/api/billing-api.d.ts

@@ -0,0 +1,460 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.8.1
+ * Contact: info@pollination.solutions
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { AppServerRestBillingDtoPayLink } from '../models';
+import type { BillingProduct } from '../models';
+import type { BillingSubscription } from '../models';
+import type { BillingSubscriptionCreate } from '../models';
+import type { BillingSubscriptionUpdate } from '../models';
+import type { BillingTransaction } from '../models';
+import type { BillingTransactionPreview } from '../models';
+/**
+ * BillingApi - axios parameter creator
+ * @export
+ */
+export declare const BillingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Cancel a subscription directly via Paddle Billing API
+     * @summary Cancel a Paddle Billing subscription
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelBillingSubscription: (subscriptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a subscription directly via Paddle Billing API
+     * @summary Create a Paddle Billing subscription directly
+     * @param {BillingSubscriptionCreate} billingSubscriptionCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionDirect: (billingSubscriptionCreate: BillingSubscriptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a Paddle Billing subscription transaction
+     * @summary Create a Paddle Billing subscription transaction
+     * @param {BillingSubscriptionCreate} billingSubscriptionCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionTransaction: (billingSubscriptionCreate: BillingSubscriptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a Paddle Billing subscription by its ID
+     * @summary Get a Paddle Billing subscription by ID
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription: (subscriptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all available products from Paddle Billing API
+     * @summary List available Paddle Billing products
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingProducts: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all Billing API transactions for a subscription
+     * @summary List Paddle Billing transactions for a subscription
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptionTransactions: (subscriptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all Paddle Billing subscriptions
+     * @summary List all Paddle Billing subscriptions
+     * @param {string} [account]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptions: (account?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Preview the cost and details of a Billing subscription before creation
+     * @summary Preview a Paddle Billing subscription transaction
+     * @param {string} subscriptionId
+     * @param {BillingSubscriptionUpdate} billingSubscriptionUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBillingSubscription: (subscriptionId: string, billingSubscriptionUpdate: BillingSubscriptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a subscription directly via Paddle Billing API
+     * @summary Update a Paddle Billing subscription
+     * @param {string} subscriptionId
+     * @param {BillingSubscriptionUpdate} billingSubscriptionUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBillingSubscription: (subscriptionId: string, billingSubscriptionUpdate: BillingSubscriptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BillingApi - functional programming interface
+ * @export
+ */
+export declare const BillingApiFp: (configuration?: Configuration) => {
+    /**
+     * Cancel a subscription directly via Paddle Billing API
+     * @summary Cancel a Paddle Billing subscription
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelBillingSubscription(subscriptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Create a subscription directly via Paddle Billing API
+     * @summary Create a Paddle Billing subscription directly
+     * @param {BillingSubscriptionCreate} billingSubscriptionCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionDirect(billingSubscriptionCreate: BillingSubscriptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AppServerRestBillingDtoPayLink>>;
+    /**
+     * Create a Paddle Billing subscription transaction
+     * @summary Create a Paddle Billing subscription transaction
+     * @param {BillingSubscriptionCreate} billingSubscriptionCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionTransaction(billingSubscriptionCreate: BillingSubscriptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AppServerRestBillingDtoPayLink>>;
+    /**
+     * Get a Paddle Billing subscription by its ID
+     * @summary Get a Paddle Billing subscription by ID
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(subscriptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingSubscription>>;
+    /**
+     * List all available products from Paddle Billing API
+     * @summary List available Paddle Billing products
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingProducts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BillingProduct>>>;
+    /**
+     * List all Billing API transactions for a subscription
+     * @summary List Paddle Billing transactions for a subscription
+     * @param {string} subscriptionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptionTransactions(subscriptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BillingTransaction>>>;
+    /**
+     * List all Paddle Billing subscriptions
+     * @summary List all Paddle Billing subscriptions
+     * @param {string} [account]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptions(account?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BillingSubscription>>>;
+    /**
+     * Preview the cost and details of a Billing subscription before creation
+     * @summary Preview a Paddle Billing subscription transaction
+     * @param {string} subscriptionId
+     * @param {BillingSubscriptionUpdate} billingSubscriptionUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBillingSubscription(subscriptionId: string, billingSubscriptionUpdate: BillingSubscriptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingTransactionPreview>>;
+    /**
+     * Update a subscription directly via Paddle Billing API
+     * @summary Update a Paddle Billing subscription
+     * @param {string} subscriptionId
+     * @param {BillingSubscriptionUpdate} billingSubscriptionUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBillingSubscription(subscriptionId: string, billingSubscriptionUpdate: BillingSubscriptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingTransaction>>;
+};
+/**
+ * BillingApi - factory interface
+ * @export
+ */
+export declare const BillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Cancel a subscription directly via Paddle Billing API
+     * @summary Cancel a Paddle Billing subscription
+     * @param {BillingApiCancelBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelBillingSubscription(requestParameters: BillingApiCancelBillingSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Create a subscription directly via Paddle Billing API
+     * @summary Create a Paddle Billing subscription directly
+     * @param {BillingApiCreateBillingSubscriptionDirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionDirect(requestParameters: BillingApiCreateBillingSubscriptionDirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<AppServerRestBillingDtoPayLink>;
+    /**
+     * Create a Paddle Billing subscription transaction
+     * @summary Create a Paddle Billing subscription transaction
+     * @param {BillingApiCreateBillingSubscriptionTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingSubscriptionTransaction(requestParameters: BillingApiCreateBillingSubscriptionTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<AppServerRestBillingDtoPayLink>;
+    /**
+     * Get a Paddle Billing subscription by its ID
+     * @summary Get a Paddle Billing subscription by ID
+     * @param {BillingApiGetBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingSubscription(requestParameters: BillingApiGetBillingSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<BillingSubscription>;
+    /**
+     * List all available products from Paddle Billing API
+     * @summary List available Paddle Billing products
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingProducts(options?: RawAxiosRequestConfig): AxiosPromise<Array<BillingProduct>>;
+    /**
+     * List all Billing API transactions for a subscription
+     * @summary List Paddle Billing transactions for a subscription
+     * @param {BillingApiListBillingSubscriptionTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptionTransactions(requestParameters: BillingApiListBillingSubscriptionTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BillingTransaction>>;
+    /**
+     * List all Paddle Billing subscriptions
+     * @summary List all Paddle Billing subscriptions
+     * @param {BillingApiListBillingSubscriptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingSubscriptions(requestParameters?: BillingApiListBillingSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BillingSubscription>>;
+    /**
+     * Preview the cost and details of a Billing subscription before creation
+     * @summary Preview a Paddle Billing subscription transaction
+     * @param {BillingApiPreviewBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBillingSubscription(requestParameters: BillingApiPreviewBillingSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<BillingTransactionPreview>;
+    /**
+     * Update a subscription directly via Paddle Billing API
+     * @summary Update a Paddle Billing subscription
+     * @param {BillingApiUpdateBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBillingSubscription(requestParameters: BillingApiUpdateBillingSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<BillingTransaction>;
+};
+/**
+ * Request parameters for cancelBillingSubscription operation in BillingApi.
+ * @export
+ * @interface BillingApiCancelBillingSubscriptionRequest
+ */
+export interface BillingApiCancelBillingSubscriptionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiCancelBillingSubscription
+     */
+    readonly subscriptionId: string;
+}
+/**
+ * Request parameters for createBillingSubscriptionDirect operation in BillingApi.
+ * @export
+ * @interface BillingApiCreateBillingSubscriptionDirectRequest
+ */
+export interface BillingApiCreateBillingSubscriptionDirectRequest {
+    /**
+     *
+     * @type {BillingSubscriptionCreate}
+     * @memberof BillingApiCreateBillingSubscriptionDirect
+     */
+    readonly billingSubscriptionCreate: BillingSubscriptionCreate;
+}
+/**
+ * Request parameters for createBillingSubscriptionTransaction operation in BillingApi.
+ * @export
+ * @interface BillingApiCreateBillingSubscriptionTransactionRequest
+ */
+export interface BillingApiCreateBillingSubscriptionTransactionRequest {
+    /**
+     *
+     * @type {BillingSubscriptionCreate}
+     * @memberof BillingApiCreateBillingSubscriptionTransaction
+     */
+    readonly billingSubscriptionCreate: BillingSubscriptionCreate;
+}
+/**
+ * Request parameters for getBillingSubscription operation in BillingApi.
+ * @export
+ * @interface BillingApiGetBillingSubscriptionRequest
+ */
+export interface BillingApiGetBillingSubscriptionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiGetBillingSubscription
+     */
+    readonly subscriptionId: string;
+}
+/**
+ * Request parameters for listBillingSubscriptionTransactions operation in BillingApi.
+ * @export
+ * @interface BillingApiListBillingSubscriptionTransactionsRequest
+ */
+export interface BillingApiListBillingSubscriptionTransactionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiListBillingSubscriptionTransactions
+     */
+    readonly subscriptionId: string;
+}
+/**
+ * Request parameters for listBillingSubscriptions operation in BillingApi.
+ * @export
+ * @interface BillingApiListBillingSubscriptionsRequest
+ */
+export interface BillingApiListBillingSubscriptionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiListBillingSubscriptions
+     */
+    readonly account?: string;
+}
+/**
+ * Request parameters for previewBillingSubscription operation in BillingApi.
+ * @export
+ * @interface BillingApiPreviewBillingSubscriptionRequest
+ */
+export interface BillingApiPreviewBillingSubscriptionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiPreviewBillingSubscription
+     */
+    readonly subscriptionId: string;
+    /**
+     *
+     * @type {BillingSubscriptionUpdate}
+     * @memberof BillingApiPreviewBillingSubscription
+     */
+    readonly billingSubscriptionUpdate: BillingSubscriptionUpdate;
+}
+/**
+ * Request parameters for updateBillingSubscription operation in BillingApi.
+ * @export
+ * @interface BillingApiUpdateBillingSubscriptionRequest
+ */
+export interface BillingApiUpdateBillingSubscriptionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingApiUpdateBillingSubscription
+     */
+    readonly subscriptionId: string;
+    /**
+     *
+     * @type {BillingSubscriptionUpdate}
+     * @memberof BillingApiUpdateBillingSubscription
+     */
+    readonly billingSubscriptionUpdate: BillingSubscriptionUpdate;
+}
+/**
+ * BillingApi - object-oriented interface
+ * @export
+ * @class BillingApi
+ * @extends {BaseAPI}
+ */
+export declare class BillingApi extends BaseAPI {
+    /**
+     * Cancel a subscription directly via Paddle Billing API
+     * @summary Cancel a Paddle Billing subscription
+     * @param {BillingApiCancelBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    cancelBillingSubscription(requestParameters: BillingApiCancelBillingSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * Create a subscription directly via Paddle Billing API
+     * @summary Create a Paddle Billing subscription directly
+     * @param {BillingApiCreateBillingSubscriptionDirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    createBillingSubscriptionDirect(requestParameters: BillingApiCreateBillingSubscriptionDirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppServerRestBillingDtoPayLink, any>>;
+    /**
+     * Create a Paddle Billing subscription transaction
+     * @summary Create a Paddle Billing subscription transaction
+     * @param {BillingApiCreateBillingSubscriptionTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    createBillingSubscriptionTransaction(requestParameters: BillingApiCreateBillingSubscriptionTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppServerRestBillingDtoPayLink, any>>;
+    /**
+     * Get a Paddle Billing subscription by its ID
+     * @summary Get a Paddle Billing subscription by ID
+     * @param {BillingApiGetBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    getBillingSubscription(requestParameters: BillingApiGetBillingSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingSubscription, any>>;
+    /**
+     * List all available products from Paddle Billing API
+     * @summary List available Paddle Billing products
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    listBillingProducts(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingProduct[], any>>;
+    /**
+     * List all Billing API transactions for a subscription
+     * @summary List Paddle Billing transactions for a subscription
+     * @param {BillingApiListBillingSubscriptionTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    listBillingSubscriptionTransactions(requestParameters: BillingApiListBillingSubscriptionTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingTransaction[], any>>;
+    /**
+     * List all Paddle Billing subscriptions
+     * @summary List all Paddle Billing subscriptions
+     * @param {BillingApiListBillingSubscriptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    listBillingSubscriptions(requestParameters?: BillingApiListBillingSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingSubscription[], any>>;
+    /**
+     * Preview the cost and details of a Billing subscription before creation
+     * @summary Preview a Paddle Billing subscription transaction
+     * @param {BillingApiPreviewBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    previewBillingSubscription(requestParameters: BillingApiPreviewBillingSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingTransactionPreview, any>>;
+    /**
+     * Update a subscription directly via Paddle Billing API
+     * @summary Update a Paddle Billing subscription
+     * @param {BillingApiUpdateBillingSubscriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    updateBillingSubscription(requestParameters: BillingApiUpdateBillingSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingTransaction, any>>;
+}