@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
852 lines (851 loc) • 34.3 kB
TypeScript
/**
* ForestVPN API
* ForestVPN - Fast, secure, and modern VPN. It offers Distributed Computing, Crypto Mining, P2P, Ad Blocking, TOR over VPN, 30+ locations, and a free version with unlimited data.
*
* OpenAPI spec version: 2.0
* Contact: support@forestvpn.com
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { BillingAccount } from '../models';
import { BillingAccountHostedPortal } from '../models';
import { BillingAccountHostedPortalCreateRequest } from '../models';
import { BillingAccountUpdateRequest } from '../models';
import { BillingFeature } from '../models';
import { Bundle } from '../models';
import { CreateStripeSetupIntentRequest } from '../models';
import { PaymentMethod } from '../models';
import { PaymentOption } from '../models';
import { Product } from '../models';
import { StripeSetupIntent } from '../models';
import { Subscription } from '../models';
import { SubscriptionCreateRequest } from '../models';
import { SubscriptionItem } from '../models';
import { SubscriptionItemCreateRequest } from '../models';
/**
* BillingApi - axios parameter creator
* @export
*/
export declare const BillingApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Cancel subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelSubscription: (subscriptionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create hosted portal for billing account
* @param {BillingAccountHostedPortalCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createBillingAccountHostedPortal: (body?: BillingAccountHostedPortalCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {CreateStripeSetupIntentRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntent: (body?: CreateStripeSetupIntentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {string} [return_url]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntentForm: (return_url?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create subscription
* @param {SubscriptionCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscription: (body?: SubscriptionCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create subscription
* @param {Array<SubscriptionItemCreateRequest>} [items]
* @param {string} [payment_method_id]
* @param {string} [promotional_code]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscriptionForm: (items?: Array<SubscriptionItemCreateRequest>, payment_method_id?: string, promotional_code?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete payment method
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deletePaymentMethod: (paymentMethodID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing account info
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Bundle info
* @param {string} bundleID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingBundle: (bundleID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Payment option info
* @param {string} paymentOptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingPaymentOption: (paymentOptionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Product info
* @param {string} productID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingProduct: (productID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Payment method info
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentMethod: (paymentMethodID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Subscription info
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscription: (subscriptionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Subscription item info
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscriptionItem: (subscriptionItemID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing bundles list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingBundles: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing feature list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingFeatures: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing payment option list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingPaymentOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing products list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingProducts: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Payment method list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listPaymentMethods: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Subscription items list
* @param {string} [subscription]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptionItems: (subscription?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Billing subscriptions list
* @param {string} [product]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptions: (product?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reactivate subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactivateSubscription: (subscriptionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update billing account
* @param {BillingAccountUpdateRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateBillingAccount: (body: BillingAccountUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update subscription item
* @param {SubscriptionItem} body
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSubscriptionItem: (body: SubscriptionItem, subscriptionItemID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* BillingApi - functional programming interface
* @export
*/
export declare const BillingApiFp: (configuration?: Configuration) => {
/**
*
* @summary Cancel subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
/**
*
* @summary Create hosted portal for billing account
* @param {BillingAccountHostedPortalCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createBillingAccountHostedPortal(body?: BillingAccountHostedPortalCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BillingAccountHostedPortal>>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {CreateStripeSetupIntentRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntent(body?: CreateStripeSetupIntentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripeSetupIntent>>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {string} [return_url]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntentForm(return_url?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripeSetupIntent>>>;
/**
*
* @summary Create subscription
* @param {SubscriptionCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscription(body?: SubscriptionCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Subscription>>>;
/**
*
* @summary Create subscription
* @param {Array<SubscriptionItemCreateRequest>} [items]
* @param {string} [payment_method_id]
* @param {string} [promotional_code]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscriptionForm(items?: Array<SubscriptionItemCreateRequest>, payment_method_id?: string, promotional_code?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Subscription>>>;
/**
*
* @summary Delete payment method
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deletePaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
/**
*
* @summary Billing account info
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BillingAccount>>>;
/**
*
* @summary Bundle info
* @param {string} bundleID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingBundle(bundleID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Bundle>>>;
/**
*
* @summary Payment option info
* @param {string} paymentOptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingPaymentOption(paymentOptionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaymentOption>>>;
/**
*
* @summary Product info
* @param {string} productID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingProduct(productID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Product>>>;
/**
*
* @summary Payment method info
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaymentMethod>>>;
/**
*
* @summary Subscription info
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Subscription>>>;
/**
*
* @summary Subscription item info
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscriptionItem(subscriptionItemID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SubscriptionItem>>>;
/**
*
* @summary Billing bundles list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingBundles(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Bundle>>>>;
/**
*
* @summary Billing feature list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingFeatures(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<BillingFeature>>>>;
/**
*
* @summary Billing payment option list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingPaymentOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<PaymentOption>>>>;
/**
*
* @summary Billing products list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingProducts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Product>>>>;
/**
*
* @summary Payment method list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listPaymentMethods(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<PaymentMethod>>>>;
/**
*
* @summary Subscription items list
* @param {string} [subscription]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptionItems(subscription?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<SubscriptionItem>>>>;
/**
*
* @summary Billing subscriptions list
* @param {string} [product]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptions(product?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Subscription>>>>;
/**
*
* @summary Reactivate subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactivateSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Subscription>>>;
/**
*
* @summary Update billing account
* @param {BillingAccountUpdateRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateBillingAccount(body: BillingAccountUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BillingAccount>>>;
/**
*
* @summary Update subscription item
* @param {SubscriptionItem} body
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSubscriptionItem(body: SubscriptionItem, subscriptionItemID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SubscriptionItem>>>;
};
/**
* BillingApi - factory interface
* @export
*/
export declare const BillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Cancel subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Create hosted portal for billing account
* @param {BillingAccountHostedPortalCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createBillingAccountHostedPortal(body?: BillingAccountHostedPortalCreateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccountHostedPortal>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {CreateStripeSetupIntentRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntent(body?: CreateStripeSetupIntentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeSetupIntent>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {string} [return_url]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentMethodStripeSetupIntentForm(return_url?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeSetupIntent>>;
/**
*
* @summary Create subscription
* @param {SubscriptionCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscription(body?: SubscriptionCreateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Create subscription
* @param {Array<SubscriptionItemCreateRequest>} [items]
* @param {string} [payment_method_id]
* @param {string} [promotional_code]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSubscriptionForm(items?: Array<SubscriptionItemCreateRequest>, payment_method_id?: string, promotional_code?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Delete payment method
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deletePaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Billing account info
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccount>>;
/**
*
* @summary Bundle info
* @param {string} bundleID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingBundle(bundleID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Bundle>>;
/**
*
* @summary Payment option info
* @param {string} paymentOptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingPaymentOption(paymentOptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PaymentOption>>;
/**
*
* @summary Product info
* @param {string} productID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBillingProduct(productID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Product>>;
/**
*
* @summary Payment method info
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PaymentMethod>>;
/**
*
* @summary Subscription info
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Subscription item info
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSubscriptionItem(subscriptionItemID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SubscriptionItem>>;
/**
*
* @summary Billing bundles list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingBundles(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Bundle>>>;
/**
*
* @summary Billing feature list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingFeatures(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<BillingFeature>>>;
/**
*
* @summary Billing payment option list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingPaymentOptions(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PaymentOption>>>;
/**
*
* @summary Billing products list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listBillingProducts(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Product>>>;
/**
*
* @summary Payment method list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listPaymentMethods(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PaymentMethod>>>;
/**
*
* @summary Subscription items list
* @param {string} [subscription]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptionItems(subscription?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<SubscriptionItem>>>;
/**
*
* @summary Billing subscriptions list
* @param {string} [product]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSubscriptions(product?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Subscription>>>;
/**
*
* @summary Reactivate subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactivateSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Update billing account
* @param {BillingAccountUpdateRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateBillingAccount(body: BillingAccountUpdateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccount>>;
/**
*
* @summary Update subscription item
* @param {SubscriptionItem} body
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSubscriptionItem(body: SubscriptionItem, subscriptionItemID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SubscriptionItem>>;
};
/**
* BillingApi - object-oriented interface
* @export
* @class BillingApi
* @extends {BaseAPI}
*/
export declare class BillingApi extends BaseAPI {
/**
*
* @summary Cancel subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
cancelSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Create hosted portal for billing account
* @param {BillingAccountHostedPortalCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
createBillingAccountHostedPortal(body?: BillingAccountHostedPortalCreateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccountHostedPortal>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {CreateStripeSetupIntentRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
createPaymentMethodStripeSetupIntent(body?: CreateStripeSetupIntentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeSetupIntent>>;
/**
*
* @summary Create stripe's setup intent for add new payment method.
* @param {string} [return_url]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
createPaymentMethodStripeSetupIntentForm(return_url?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeSetupIntent>>;
/**
*
* @summary Create subscription
* @param {SubscriptionCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
createSubscription(body?: SubscriptionCreateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Create subscription
* @param {Array<SubscriptionItemCreateRequest>} [items]
* @param {string} [payment_method_id]
* @param {string} [promotional_code]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
createSubscriptionForm(items?: Array<SubscriptionItemCreateRequest>, payment_method_id?: string, promotional_code?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Delete payment method
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
deletePaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Billing account info
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getBillingAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccount>>;
/**
*
* @summary Bundle info
* @param {string} bundleID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getBillingBundle(bundleID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Bundle>>;
/**
*
* @summary Payment option info
* @param {string} paymentOptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getBillingPaymentOption(paymentOptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PaymentOption>>;
/**
*
* @summary Product info
* @param {string} productID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getBillingProduct(productID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Product>>;
/**
*
* @summary Payment method info
* @param {string} paymentMethodID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getPaymentMethod(paymentMethodID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PaymentMethod>>;
/**
*
* @summary Subscription info
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Subscription item info
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
getSubscriptionItem(subscriptionItemID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SubscriptionItem>>;
/**
*
* @summary Billing bundles list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listBillingBundles(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Bundle>>>;
/**
*
* @summary Billing feature list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listBillingFeatures(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<BillingFeature>>>;
/**
*
* @summary Billing payment option list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listBillingPaymentOptions(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PaymentOption>>>;
/**
*
* @summary Billing products list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listBillingProducts(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Product>>>;
/**
*
* @summary Payment method list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listPaymentMethods(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PaymentMethod>>>;
/**
*
* @summary Subscription items list
* @param {string} [subscription]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listSubscriptionItems(subscription?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<SubscriptionItem>>>;
/**
*
* @summary Billing subscriptions list
* @param {string} [product]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
listSubscriptions(product?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Subscription>>>;
/**
*
* @summary Reactivate subscription
* @param {string} subscriptionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
reactivateSubscription(subscriptionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Subscription>>;
/**
*
* @summary Update billing account
* @param {BillingAccountUpdateRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
updateBillingAccount(body: BillingAccountUpdateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BillingAccount>>;
/**
*
* @summary Update subscription item
* @param {SubscriptionItem} body
* @param {string} subscriptionItemID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BillingApi
*/
updateSubscriptionItem(body: SubscriptionItem, subscriptionItemID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SubscriptionItem>>;
}