@teemill/platform 0.3.0 → 0.4.0

package/api.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,6 +23,61 @@ import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
 
+/**
+ * A person\'s address.
+ * @export
+ * @interface Address
+ */
+export interface Address {
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    'contactName': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    'company'?: string;
+    /**
+     * First line of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'line1': string;
+    /**
+     * Second line of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'line2'?: string;
+    /**
+     * City of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'city': string;
+    /**
+     * Postal code of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'postalCode'?: string;
+    /**
+     * Country of the address (ISO 3166-1 alpha-2).
+     * @type {string}
+     * @memberof Address
+     */
+    'country': string;
+    /**
+     * State of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'state'?: string;
+}
 /**
  * 
  * @export
@@ -42,6 +97,379 @@ export interface ApiError {
      */
     'message': string;
 }
+/**
+ * Order recipient contact information, used only for courier tracking/updates.
+ * @export
+ * @interface ContactInformation
+ */
+export interface ContactInformation {
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInformation
+     */
+    'email': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInformation
+     */
+    'phone'?: string | null;
+}
+/**
+ * 
+ * @export
+ * @interface DeliveryEstimates
+ */
+export interface DeliveryEstimates {
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof DeliveryEstimates
+     */
+    'min'?: string;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof DeliveryEstimates
+     */
+    'max'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ExportOrders202Response
+ */
+export interface ExportOrders202Response {
+    /**
+     * A message describing the export status
+     * @type {string}
+     * @memberof ExportOrders202Response
+     */
+    'message'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface Fulfillment
+ */
+export interface Fulfillment {
+    /**
+     * Unique fulfillment id
+     * @type {string}
+     * @memberof Fulfillment
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {OrderStatus}
+     * @memberof Fulfillment
+     */
+    'status'?: OrderStatus;
+    /**
+     * 
+     * @type {Array<FulfillmentItem>}
+     * @memberof Fulfillment
+     */
+    'items'?: Array<FulfillmentItem>;
+    /**
+     * 
+     * @type {OrderTracking}
+     * @memberof Fulfillment
+     */
+    'tracking'?: OrderTracking | null;
+    /**
+     * Shipping method currently set
+     * @type {ShippingMethod}
+     * @memberof Fulfillment
+     */
+    'shippingMethod'?: ShippingMethod;
+    /**
+     * Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
+     * @type {Array<ShippingMethod>}
+     * @memberof Fulfillment
+     */
+    'availableShippingMethods'?: Array<ShippingMethod>;
+    /**
+     * Weight of the package being shipped in grams
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'packageWeight'?: number;
+}
+
+
+/**
+ * 
+ * @export
+ * @interface FulfillmentItem
+ */
+export interface FulfillmentItem {
+    /**
+     * Unique fulfillment item id
+     * @type {string}
+     * @memberof FulfillmentItem
+     */
+    'id'?: string;
+    /**
+     * Id of the order item being fulfilled
+     * @type {string}
+     * @memberof FulfillmentItem
+     */
+    'itemId'?: string;
+    /**
+     * Number of this item being fulfilled
+     * @type {number}
+     * @memberof FulfillmentItem
+     */
+    'quantity'?: number;
+}
+/**
+ * 
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Order
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Order
+     */
+    'ref'?: string;
+    /**
+     * 
+     * @type {OrderStatus}
+     * @memberof Order
+     */
+    'status'?: OrderStatus;
+    /**
+     * 
+     * @type {ContactInformation}
+     * @memberof Order
+     */
+    'contactInformation': ContactInformation;
+    /**
+     * 
+     * @type {Address}
+     * @memberof Order
+     */
+    'shippingAddress': Address;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Order
+     */
+    'createdAt'?: string;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Order
+     */
+    'updatedAt'?: string;
+    /**
+     * A custom reference to the merchant\'s order that will be displayed on the shipping label.
+     * @type {string}
+     * @memberof Order
+     */
+    'merchantReference'?: string | null;
+    /**
+     * 
+     * @type {Array<Fulfillment>}
+     * @memberof Order
+     */
+    'fulfillments'?: Array<Fulfillment>;
+    /**
+     * 
+     * @type {Array<OrderItem>}
+     * @memberof Order
+     */
+    'items': Array<OrderItem>;
+    /**
+     * 
+     * @type {Price}
+     * @memberof Order
+     */
+    'totalPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof Order
+     */
+    'taxPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof Order
+     */
+    'subtotalPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof Order
+     */
+    'discountPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof Order
+     */
+    'shippingPrice'?: Price;
+    /**
+     * 
+     * @type {Origin}
+     * @memberof Order
+     */
+    'origin'?: Origin;
+    /**
+     * 
+     * @type {Array<StatusHistoryItem>}
+     * @memberof Order
+     */
+    'statusHistory'?: Array<StatusHistoryItem>;
+}
+
+
+/**
+ * 
+ * @export
+ * @interface OrderItem
+ */
+export interface OrderItem {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'id'?: string;
+    /**
+     * Reference URL to the order item variant
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'variantRef': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderItem
+     */
+    'quantity': number;
+    /**
+     * 
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'totalPrice'?: Price;
+    /**
+     * This is an estimate until the order has been confirmed
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'taxPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'subtotalPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'discountPrice'?: Price;
+    /**
+     * The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'recipientCost'?: Price;
+}
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const OrderStatus = {
+    New: 'new',
+    Paid: 'paid',
+    Processing: 'processing',
+    Complete: 'complete',
+    Refunded: 'refunded'
+} as const;
+
+export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
+
+
+/**
+ * 
+ * @export
+ * @interface OrderTracking
+ */
+export interface OrderTracking {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'courier'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'url'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface OrdersResponse
+ */
+export interface OrdersResponse {
+    /**
+     * 
+     * @type {Array<Order>}
+     * @memberof OrdersResponse
+     */
+    'orders'?: Array<Order>;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrdersResponse
+     */
+    'nextPageToken'?: number;
+}
+/**
+ * 
+ * @export
+ * @interface Origin
+ */
+export interface Origin {
+    /**
+     * 
+     * @type {string}
+     * @memberof Origin
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Origin
+     */
+    'isPaid'?: boolean;
+}
 /**
  * 
  * @export
@@ -51,86 +479,595 @@ export interface Platform {
     /**
      * 
      * @type {string}
-     * @memberof Platform
+     * @memberof Platform
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Platform
+     */
+    'name': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof Platform
+     */
+    'domains': Array<string>;
+    /**
+     * 
+     * @type {Array<PlatformLogo>}
+     * @memberof Platform
+     */
+    'logos': Array<PlatformLogo>;
+}
+/**
+ * 
+ * @export
+ * @interface PlatformLogo
+ */
+export interface PlatformLogo {
+    /**
+     * 
+     * @type {string}
+     * @memberof PlatformLogo
+     */
+    'url': string;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof PlatformLogo
+     */
+    'meta': { [key: string]: string; };
+}
+/**
+ * Standard price definition that defines the amount and currency.
+ * @export
+ * @interface Price
+ */
+export interface Price {
+    /**
+     * Price including tax in the specified currency.
+     * @type {string}
+     * @memberof Price
+     */
+    'amount'?: string;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof Price
+     */
+    'currencyCode'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ShippingMethod
+ */
+export interface ShippingMethod {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {DeliveryEstimates}
+     * @memberof ShippingMethod
+     */
+    'deliveryEstimates'?: DeliveryEstimates;
+    /**
+     * 
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'totalPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'taxPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'subtotalPrice'?: Price;
+    /**
+     * 
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'discountPrice'?: Price;
+}
+/**
+ * 
+ * @export
+ * @interface StatusHistoryItem
+ */
+export interface StatusHistoryItem {
+    /**
+     * 
+     * @type {OrderStatus}
+     * @memberof StatusHistoryItem
+     */
+    'status'?: OrderStatus;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof StatusHistoryItem
+     */
+    'createdAt'?: string;
+}
+
+
+/**
+ * 
+ * @export
+ * @interface UpdatePlatformRequest
+ */
+export interface UpdatePlatformRequest {
+    /**
+     * 
+     * @type {Array<PlatformLogo>}
+     * @memberof UpdatePlatformRequest
+     */
+    'logos'?: Array<PlatformLogo>;
+}
+/**
+ * 
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ValidationError
+     */
+    'message': string;
+    /**
+     * 
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof ValidationError
+     */
+    'errors': { [key: string]: Array<string>; };
+}
+
+/**
+ * OrdersApi - axios parameter creator
+ * @export
+ */
+export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} start Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportOrders: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportOrders', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('exportOrders', 'platformId', platformId)
+            // verify required parameter 'start' is not null or undefined
+            assertParamExists('exportOrders', 'start', start)
+            const localVarPath = `/v1/platform/{platformId}/orders/export`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = (start as any instanceof Date) ?
+                    (start as any).toISOString() :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString() :
+                    end;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @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 {string} [start] Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listOrders', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('listOrders', 'platformId', platformId)
+            const localVarPath = `/v1/platform/{platformId}/orders`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = (start as any instanceof Date) ?
+                    (start as any).toISOString() :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString() :
+                    end;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * OrdersApi - functional programming interface
+ * @export
+ */
+export const OrdersApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} start Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.exportOrders']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @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 {string} [start] Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * OrdersApi - factory interface
+ * @export
+ */
+export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = OrdersApiFp(configuration)
+    return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
+            return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for exportOrders operation in OrdersApi.
+ * @export
+ * @interface OrdersApiExportOrdersRequest
+ */
+export interface OrdersApiExportOrdersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly platformId: string
+
+    /**
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly start: string
+
+    /**
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly end?: string
+}
+
+/**
+ * Request parameters for listOrders operation in OrdersApi.
+ * @export
+ * @interface OrdersApiListOrdersRequest
+ */
+export interface OrdersApiListOrdersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiListOrders
      */
-    'id': string;
+    readonly project: string
+
     /**
-     * 
+     * The platform identifier
      * @type {string}
-     * @memberof Platform
+     * @memberof OrdersApiListOrders
      */
-    'name': string;
+    readonly platformId: string
+
     /**
-     * 
-     * @type {Array<string>}
-     * @memberof Platform
+     * Page reference token
+     * @type {number}
+     * @memberof OrdersApiListOrders
      */
-    'domains': Array<string>;
+    readonly pageToken?: number
+
     /**
-     * 
-     * @type {Array<PlatformLogo>}
-     * @memberof Platform
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof OrdersApiListOrders
      */
-    'logos': Array<PlatformLogo>;
-}
-/**
- * 
- * @export
- * @interface PlatformLogo
- */
-export interface PlatformLogo {
+    readonly pageSize?: number
+
     /**
-     * 
+     * Search term to filter based on order reference, customer name and email
      * @type {string}
-     * @memberof PlatformLogo
+     * @memberof OrdersApiListOrders
      */
-    'url': string;
+    readonly search?: string
+
     /**
-     * 
-     * @type {{ [key: string]: string; }}
-     * @memberof PlatformLogo
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiListOrders
      */
-    'meta': { [key: string]: string; };
-}
-/**
- * 
- * @export
- * @interface UpdatePlatformRequest
- */
-export interface UpdatePlatformRequest {
+    readonly start?: string
+
     /**
-     * 
-     * @type {Array<PlatformLogo>}
-     * @memberof UpdatePlatformRequest
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiListOrders
      */
-    'logos'?: Array<PlatformLogo>;
+    readonly end?: string
 }
+
 /**
- * 
+ * OrdersApi - object-oriented interface
  * @export
- * @interface ValidationError
+ * @class OrdersApi
+ * @extends {BaseAPI}
  */
-export interface ValidationError {
+export class OrdersApi extends BaseAPI {
     /**
-     * 
-     * @type {string}
-     * @memberof ValidationError
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
      */
-    'message': string;
+    public exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
-     * 
-     * @type {{ [key: string]: Array<string>; }}
-     * @memberof ValidationError
+     * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List orders
+     * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
      */
-    'errors': { [key: string]: Array<string>; };
+    public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
+
+
 /**
  * PlatformApi - axios parameter creator
  * @export
  */
 export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} start Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportOrders: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportOrders', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('exportOrders', 'platformId', platformId)
+            // verify required parameter 'start' is not null or undefined
+            assertParamExists('exportOrders', 'start', start)
+            const localVarPath = `/v1/platform/{platformId}/orders/export`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = (start as any instanceof Date) ?
+                    (start as any).toISOString() :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString() :
+                    end;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get platform details
@@ -166,6 +1103,83 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @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 {string} [start] Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listOrders', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('listOrders', 'platformId', platformId)
+            const localVarPath = `/v1/platform/{platformId}/orders`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = (start as any instanceof Date) ?
+                    (start as any).toISOString() :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString() :
+                    end;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -235,6 +1249,22 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
 export const PlatformApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} start Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get platform details
@@ -248,6 +1278,25 @@ export const PlatformApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @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 {string} [start] Start of date range to filter by when orders were placed
+         * @param {string} [end] End of date range to filter by when orders were placed
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PlatformApi.listOrders']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Update platform
@@ -272,6 +1321,16 @@ export const PlatformApiFp = function(configuration?: Configuration) {
 export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = PlatformApiFp(configuration)
     return {
+        /**
+         * Export orders as a CSV file
+         * @summary Export orders
+         * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get platform details
@@ -282,6 +1341,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
         getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
             return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+         * @summary List orders
+         * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
+            return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Update platform
@@ -295,6 +1364,41 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
     };
 };
 
+/**
+ * Request parameters for exportOrders operation in PlatformApi.
+ * @export
+ * @interface PlatformApiExportOrdersRequest
+ */
+export interface PlatformApiExportOrdersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PlatformApiExportOrders
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PlatformApiExportOrders
+     */
+    readonly platformId: string
+
+    /**
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof PlatformApiExportOrders
+     */
+    readonly start: string
+
+    /**
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof PlatformApiExportOrders
+     */
+    readonly end?: string
+}
+
 /**
  * Request parameters for getPlatform operation in PlatformApi.
  * @export
@@ -309,6 +1413,62 @@ export interface PlatformApiGetPlatformRequest {
     readonly project: string
 }
 
+/**
+ * Request parameters for listOrders operation in PlatformApi.
+ * @export
+ * @interface PlatformApiListOrdersRequest
+ */
+export interface PlatformApiListOrdersRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PlatformApiListOrders
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PlatformApiListOrders
+     */
+    readonly platformId: string
+
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PlatformApiListOrders
+     */
+    readonly pageToken?: number
+
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PlatformApiListOrders
+     */
+    readonly pageSize?: number
+
+    /**
+     * Search term to filter based on order reference, customer name and email
+     * @type {string}
+     * @memberof PlatformApiListOrders
+     */
+    readonly search?: string
+
+    /**
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof PlatformApiListOrders
+     */
+    readonly start?: string
+
+    /**
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof PlatformApiListOrders
+     */
+    readonly end?: string
+}
+
 /**
  * Request parameters for updatePlatform operation in PlatformApi.
  * @export
@@ -337,6 +1497,18 @@ export interface PlatformApiUpdatePlatformRequest {
  * @extends {BaseAPI}
  */
 export class PlatformApi extends BaseAPI {
+    /**
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlatformApi
+     */
+    public exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
+        return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get platform details
@@ -349,6 +1521,18 @@ export class PlatformApi extends BaseAPI {
         return PlatformApiFp(this.configuration).getPlatform(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List orders
+     * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlatformApi
+     */
+    public listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig) {
+        return PlatformApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Update platform