@teemill/platform 0.12.3 → 0.14.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.12.3
+ * The version of the OpenAPI document: 0.14.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -143,6 +143,19 @@ export interface ApplicationTechnology {
      */
     'ref'?: string;
 }
+/**
+ *
+ * @export
+ * @interface AuthorizeStripe200Response
+ */
+export interface AuthorizeStripe200Response {
+    /**
+     * The URL to redirect to
+     * @type {string}
+     * @memberof AuthorizeStripe200Response
+     */
+    'redirect_url': string;
+}
 /**
  * Order recipient contact information, used only for courier tracking/updates.
  * @export
@@ -956,6 +969,37 @@ export interface OutputPadding {
      */
     'left': number;
 }
+/**
+ *
+ * @export
+ * @interface PaymentAccount
+ */
+export interface PaymentAccount {
+    /**
+     * The name of the payment account
+     * @type {string}
+     * @memberof PaymentAccount
+     */
+    'name': string;
+    /**
+     * The payment method
+     * @type {string}
+     * @memberof PaymentAccount
+     */
+    'method': PaymentAccountMethodEnum;
+    /**
+     * The configuration for the payment account
+     * @type {{ [key: string]: string; }}
+     * @memberof PaymentAccount
+     */
+    'config': {
+        [key: string]: string;
+    };
+}
+export declare const PaymentAccountMethodEnum: {
+    readonly Stripe: "stripe";
+};
+export type PaymentAccountMethodEnum = typeof PaymentAccountMethodEnum[keyof typeof PaymentAccountMethodEnum];
 /**
  *
  * @export
@@ -1718,13 +1762,14 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
      * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
+     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers: (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -1745,12 +1790,13 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
+     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CustomersApi - functional programming interface
@@ -1763,13 +1809,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
      * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
+     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Get a customer for a platform by a given customer ID.
      * @summary Get customer
@@ -1790,12 +1837,13 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
+     * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
      * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
      * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
+    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
 };
 /**
  * CustomersApi - factory interface
@@ -1851,6 +1899,12 @@ export interface CustomersApiExportCustomersRequest {
      * @memberof CustomersApiExportCustomers
      */
     readonly totalOrderCount?: number;
+    /**
+     * Filter customers by lifetime value less than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly lifetimeValue?: number;
     /**
      * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
@@ -1943,6 +1997,12 @@ export interface CustomersApiListCustomersRequest {
      * @memberof CustomersApiListCustomers
      */
     readonly totalOrderCount?: number;
+    /**
+     * Filter customers by lifetime value less than or equal to the value provided
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly lifetimeValue?: number;
     /**
      * Start of date range to filter customers by last purchase date
      * @type {string}
@@ -2469,6 +2529,170 @@ export declare class OrdersApi extends BaseAPI {
      */
     updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
 }
+/**
+ * PaymentApi - axios parameter creator
+ * @export
+ */
+export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Authorize a Stripe payment account
+     * @summary Authorize Stripe
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeStripe: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deauthorize a Stripe payment account
+     * @summary Deauthorize Stripe
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deauthorizeStripe: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the Stripe payment account for the project
+     * @summary Get Stripe Payment Account
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStripePaymentAccount: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PaymentApi - functional programming interface
+ * @export
+ */
+export declare const PaymentApiFp: (configuration?: Configuration) => {
+    /**
+     * Authorize a Stripe payment account
+     * @summary Authorize Stripe
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizeStripe200Response>>;
+    /**
+     * Deauthorize a Stripe payment account
+     * @summary Deauthorize Stripe
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deauthorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get the Stripe payment account for the project
+     * @summary Get Stripe Payment Account
+     * @param {string} project Project unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStripePaymentAccount(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentAccount>>;
+};
+/**
+ * PaymentApi - factory interface
+ * @export
+ */
+export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Authorize a Stripe payment account
+     * @summary Authorize Stripe
+     * @param {PaymentApiAuthorizeStripeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizeStripe200Response>;
+    /**
+     * Deauthorize a Stripe payment account
+     * @summary Deauthorize Stripe
+     * @param {PaymentApiDeauthorizeStripeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deauthorizeStripe(requestParameters: PaymentApiDeauthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get the Stripe payment account for the project
+     * @summary Get Stripe Payment Account
+     * @param {PaymentApiGetStripePaymentAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentAccount>;
+};
+/**
+ * Request parameters for authorizeStripe operation in PaymentApi.
+ * @export
+ * @interface PaymentApiAuthorizeStripeRequest
+ */
+export interface PaymentApiAuthorizeStripeRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PaymentApiAuthorizeStripe
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for deauthorizeStripe operation in PaymentApi.
+ * @export
+ * @interface PaymentApiDeauthorizeStripeRequest
+ */
+export interface PaymentApiDeauthorizeStripeRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PaymentApiDeauthorizeStripe
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for getStripePaymentAccount operation in PaymentApi.
+ * @export
+ * @interface PaymentApiGetStripePaymentAccountRequest
+ */
+export interface PaymentApiGetStripePaymentAccountRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PaymentApiGetStripePaymentAccount
+     */
+    readonly project: string;
+}
+/**
+ * PaymentApi - object-oriented interface
+ * @export
+ * @class PaymentApi
+ * @extends {BaseAPI}
+ */
+export declare class PaymentApi extends BaseAPI {
+    /**
+     * Authorize a Stripe payment account
+     * @summary Authorize Stripe
+     * @param {PaymentApiAuthorizeStripeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizeStripe200Response, any>>;
+    /**
+     * Deauthorize a Stripe payment account
+     * @summary Deauthorize Stripe
+     * @param {PaymentApiDeauthorizeStripeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    deauthorizeStripe(requestParameters: PaymentApiDeauthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get the Stripe payment account for the project
+     * @summary Get Stripe Payment Account
+     * @param {PaymentApiGetStripePaymentAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentApi
+     */
+    getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any>>;
+}
 /**
  * PlatformApi - axios parameter creator
  * @export