@teemill/platform 0.10.0 → 0.11.1

package/base.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.10.0
+ * The version of the OpenAPI document: 0.11.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.10.0
+ * The version of the OpenAPI document: 0.11.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.10.0
+ * The version of the OpenAPI document: 0.11.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/0.11.1/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.10.0
+ * The version of the OpenAPI document: 0.11.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -162,6 +162,56 @@ export interface ContactInformation {
      */
     'phone'?: string | null;
 }
+/**
+ * The customer that has placed an order on your platform
+ * @export
+ * @interface Customer
+ */
+export interface Customer {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Customer
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Customer
+     */
+    'email': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Customer
+     */
+    'firstName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Customer
+     */
+    'lastName'?: string;
+}
+/**
+ *
+ * @export
+ * @interface CustomersResponse
+ */
+export interface CustomersResponse {
+    /**
+     *
+     * @type {Array<Customer>}
+     * @memberof CustomersResponse
+     */
+    'customers': Array<Customer>;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomersResponse
+     */
+    'nextPageToken'?: number | null;
+}
 /**
  *
  * @export
@@ -1586,6 +1636,226 @@ export interface VariantPackedDimensions {
      */
     'depth'?: number;
 }
+/**
+ * CustomersApi - axios parameter creator
+ * @export
+ */
+export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CustomersApi - functional programming interface
+ * @export
+ */
+export declare const CustomersApiFp: (configuration?: Configuration) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
+};
+/**
+ * CustomersApi - factory interface
+ * @export
+ */
+export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
+};
+/**
+ * Request parameters for exportCustomers operation in CustomersApi.
+ * @export
+ * @interface CustomersApiExportCustomersRequest
+ */
+export interface CustomersApiExportCustomersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof CustomersApiExportCustomers
+     */
+    readonly platformId: string;
+}
+/**
+ * Request parameters for getCustomer operation in CustomersApi.
+ * @export
+ * @interface CustomersApiGetCustomerRequest
+ */
+export interface CustomersApiGetCustomerRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof CustomersApiGetCustomer
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof CustomersApiGetCustomer
+     */
+    readonly platformId: string;
+    /**
+     * The customer identifier
+     * @type {string}
+     * @memberof CustomersApiGetCustomer
+     */
+    readonly customerId: string;
+}
+/**
+ * Request parameters for listCustomers operation in CustomersApi.
+ * @export
+ * @interface CustomersApiListCustomersRequest
+ */
+export interface CustomersApiListCustomersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter based on order reference, customer name and email
+     * @type {string}
+     * @memberof CustomersApiListCustomers
+     */
+    readonly search?: string;
+}
+/**
+ * CustomersApi - object-oriented interface
+ * @export
+ * @class CustomersApi
+ * @extends {BaseAPI}
+ */
+export declare class CustomersApi extends BaseAPI {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomersApi
+     */
+    exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomersApi
+     */
+    getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomersApi
+     */
+    listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
+}
 /**
  * OrdersApi - axios parameter creator
  * @export
@@ -2045,6 +2315,15 @@ export declare class OrdersApi extends BaseAPI {
  * @export
  */
 export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2057,6 +2336,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a fulfillment for a platform by a given fulfillment ID.
      * @summary Get fulfillment
@@ -2095,6 +2384,18 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
      * @summary List orders
@@ -2157,6 +2458,15 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const PlatformApiFp: (configuration?: Configuration) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2169,6 +2479,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} customerId The customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
     /**
      * Get a fulfillment for a platform by a given fulfillment ID.
      * @summary Get fulfillment
@@ -2207,6 +2527,18 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
     /**
      * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
      * @summary List orders
@@ -2269,6 +2601,14 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2277,6 +2617,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
     /**
      * Get a fulfillment for a platform by a given fulfillment ID.
      * @summary Get fulfillment
@@ -2309,6 +2657,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
     /**
      * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
      * @summary List orders
@@ -2350,6 +2706,25 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
      */
     updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
 };
+/**
+ * Request parameters for exportCustomers operation in PlatformApi.
+ * @export
+ * @interface PlatformApiExportCustomersRequest
+ */
+export interface PlatformApiExportCustomersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PlatformApiExportCustomers
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PlatformApiExportCustomers
+     */
+    readonly platformId: string;
+}
 /**
  * Request parameters for exportOrders operation in PlatformApi.
  * @export
@@ -2387,6 +2762,31 @@ export interface PlatformApiExportOrdersRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for getCustomer operation in PlatformApi.
+ * @export
+ * @interface PlatformApiGetCustomerRequest
+ */
+export interface PlatformApiGetCustomerRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PlatformApiGetCustomer
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PlatformApiGetCustomer
+     */
+    readonly platformId: string;
+    /**
+     * The customer identifier
+     * @type {string}
+     * @memberof PlatformApiGetCustomer
+     */
+    readonly customerId: string;
+}
 /**
  * Request parameters for getFulfillment operation in PlatformApi.
  * @export
@@ -2475,6 +2875,43 @@ export interface PlatformApiListAvailableFulfillersRequest {
      */
     readonly fulfillmentId: string;
 }
+/**
+ * Request parameters for listCustomers operation in PlatformApi.
+ * @export
+ * @interface PlatformApiListCustomersRequest
+ */
+export interface PlatformApiListCustomersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PlatformApiListCustomers
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PlatformApiListCustomers
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PlatformApiListCustomers
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PlatformApiListCustomers
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter based on order reference, customer name and email
+     * @type {string}
+     * @memberof PlatformApiListCustomers
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for listOrders operation in PlatformApi.
  * @export
@@ -2643,6 +3080,15 @@ export interface PlatformApiUpdateVariantRequest {
  * @extends {BaseAPI}
  */
 export declare class PlatformApi extends BaseAPI {
+    /**
+     * Export customers as a CSV file
+     * @summary Export customers
+     * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlatformApi
+     */
+    exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2652,6 +3098,15 @@ export declare class PlatformApi extends BaseAPI {
      * @memberof PlatformApi
      */
     exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get a customer for a platform by a given customer ID.
+     * @summary Get customer
+     * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlatformApi
+     */
+    getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
     /**
      * Get a fulfillment for a platform by a given fulfillment ID.
      * @summary Get fulfillment
@@ -2688,6 +3143,15 @@ export declare class PlatformApi extends BaseAPI {
      * @memberof PlatformApi
      */
     listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
+    /**
+     * List customers for a platform
+     * @summary List customers
+     * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlatformApi
+     */
+    listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
     /**
      * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
      * @summary List orders