@teemill/platform 0.27.0 → 0.28.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/platform@0.27.0
+## @teemill/platform@0.28.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/platform@0.27.0 --save
+npm install @teemill/platform@0.28.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -59,6 +59,8 @@ Class | Method | HTTP request | Description
 *EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
 *EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
 *EnquiriesApi* | [**updateCustomerEnquiry**](docs/EnquiriesApi.md#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry
+*OrdersApi* | [**confirmOrder**](docs/OrdersApi.md#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order
+*OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/platform/{platformId}/orders | Create order
 *OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
 *OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
 *OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
@@ -92,12 +94,18 @@ Class | Method | HTTP request | Description
  - [Address](docs/Address.md)
  - [ApiError](docs/ApiError.md)
  - [Client](docs/Client.md)
+ - [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
+ - [ConfirmOrderFulfillmentShipment](docs/ConfirmOrderFulfillmentShipment.md)
+ - [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
  - [ContactInformation](docs/ContactInformation.md)
  - [Coupon](docs/Coupon.md)
  - [CreateChatChannel200Response](docs/CreateChatChannel200Response.md)
  - [CreateDomainRequest](docs/CreateDomainRequest.md)
+ - [CreateOrder](docs/CreateOrder.md)
+ - [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
  - [Customer](docs/Customer.md)
  - [CustomersResponse](docs/CustomersResponse.md)
+ - [CustomsInformation](docs/CustomsInformation.md)
  - [DeliveryEstimates](docs/DeliveryEstimates.md)
  - [Domain](docs/Domain.md)
  - [Enquiry](docs/Enquiry.md)
@@ -120,6 +128,8 @@ Class | Method | HTTP request | Description
  - [Option](docs/Option.md)
  - [Order](docs/Order.md)
  - [OrderItem](docs/OrderItem.md)
+ - [OrderItem1](docs/OrderItem1.md)
+ - [OrderItem1RecipientCost](docs/OrderItem1RecipientCost.md)
  - [OrderStatus](docs/OrderStatus.md)
  - [OrderTracking](docs/OrderTracking.md)
  - [OrdersResponse](docs/OrdersResponse.md)

package/api.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.27.0
+ * The version of the OpenAPI document: 0.28.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -122,6 +122,57 @@ export interface Client {
      */
     'name'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface ConfirmOrderFulfillment
+ */
+export interface ConfirmOrderFulfillment {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ConfirmOrderFulfillment
+     */
+    'fulfillmentId': string;
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ConfirmOrderFulfillment
+     */
+    'shippingMethodId'?: string;
+    /**
+     * 
+     * @type {ConfirmOrderFulfillmentShipment}
+     * @memberof ConfirmOrderFulfillment
+     */
+    'shipment'?: ConfirmOrderFulfillmentShipment;
+}
+/**
+ * This field is only required if you are using your own shipping label.
+ * @export
+ * @interface ConfirmOrderFulfillmentShipment
+ */
+export interface ConfirmOrderFulfillmentShipment {
+    /**
+     * Only required if you are generating shipping labels outside of PodOS
+     * @type {string}
+     * @memberof ConfirmOrderFulfillmentShipment
+     */
+    'image': string;
+}
+/**
+ * 
+ * @export
+ * @interface ConfirmOrderRequest
+ */
+export interface ConfirmOrderRequest {
+    /**
+     * 
+     * @type {Array<ConfirmOrderFulfillment>}
+     * @memberof ConfirmOrderRequest
+     */
+    'fulfillments': Array<ConfirmOrderFulfillment>;
+}
 /**
  * Order recipient contact information, used only for courier tracking/updates.
  * @export
@@ -186,6 +237,74 @@ export interface CreateDomainRequest {
      */
     'domain'?: string;
 }
+/**
+ * Create an order
+ * @export
+ * @interface CreateOrder
+ */
+export interface CreateOrder {
+    /**
+     * A custom reference to the merchant\'s order.
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    'merchantReference'?: string | null;
+    /**
+     * 
+     * @type {CreateOrderContactInformation}
+     * @memberof CreateOrder
+     */
+    'contactInformation': CreateOrderContactInformation;
+    /**
+     * 
+     * @type {Address}
+     * @memberof CreateOrder
+     */
+    'shippingAddress': Address;
+    /**
+     * 
+     * @type {CustomsInformation}
+     * @memberof CreateOrder
+     */
+    'customsInformation'?: CustomsInformation;
+    /**
+     * Items to be ordered
+     * @type {Array<OrderItem1>}
+     * @memberof CreateOrder
+     */
+    'items': Array<OrderItem1>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateOrder
+     */
+    'preferredFulfillers'?: Array<string>;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    'originalOrderRef'?: string;
+}
+/**
+ * Contact information for the order
+ * @export
+ * @interface CreateOrderContactInformation
+ */
+export interface CreateOrderContactInformation {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateOrderContactInformation
+     */
+    'email': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateOrderContactInformation
+     */
+    'phone'?: string | null;
+}
 /**
  * The customer that has placed an order on your platform
  * @export
@@ -254,6 +373,44 @@ export interface CustomersResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ * Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
+ * @export
+ * @interface CustomsInformation
+ */
+export interface CustomsInformation {
+    /**
+     * Pre-registration type
+     * @type {string}
+     * @memberof CustomsInformation
+     */
+    'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
+    /**
+     * Pre-registration number
+     * @type {string}
+     * @memberof CustomsInformation
+     */
+    'preRegistrationNumber'?: string;
+    /**
+     * VAT number
+     * @type {string}
+     * @memberof CustomsInformation
+     */
+    'vatNumber'?: string;
+    /**
+     * EORI number
+     * @type {string}
+     * @memberof CustomsInformation
+     */
+    'eoriNumber'?: string;
+}
+
+export const CustomsInformationPreRegistrationTypeEnum = {
+    Ioss: 'IOSS'
+} as const;
+
+export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
+
 /**
  * 
  * @export
@@ -985,6 +1142,50 @@ export interface OrderItem {
      */
     'recipientCost'?: Price;
 }
+/**
+ * 
+ * @export
+ * @interface OrderItem1
+ */
+export interface OrderItem1 {
+    /**
+     * A reference to the variant being ordered
+     * @type {string}
+     * @memberof OrderItem1
+     */
+    'variantRef': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderItem1
+     */
+    'quantity': number;
+    /**
+     * 
+     * @type {OrderItem1RecipientCost}
+     * @memberof OrderItem1
+     */
+    'recipientCost'?: OrderItem1RecipientCost;
+}
+/**
+ * 
+ * @export
+ * @interface OrderItem1RecipientCost
+ */
+export interface OrderItem1RecipientCost {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderItem1RecipientCost
+     */
+    'amount': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderItem1RecipientCost
+     */
+    'currencyCode': string;
+}
 /**
  * 
  * @export
@@ -3125,6 +3326,118 @@ export class EnquiriesApi extends BaseAPI {
  */
 export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 
+         * @summary Confirm order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        confirmOrder: async (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('confirmOrder', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('confirmOrder', 'platformId', platformId)
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('confirmOrder', 'orderId', orderId)
+            // verify required parameter 'confirmOrderRequest' is not null or undefined
+            assertParamExists('confirmOrder', 'confirmOrderRequest', confirmOrderRequest)
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/confirm`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
+                .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
+            // 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: 'POST', ...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;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(confirmOrderRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Create order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateOrder} createOrder Create Order schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrder: async (project: string, platformId: string, createOrder: CreateOrder, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('createOrder', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('createOrder', 'platformId', platformId)
+            // verify required parameter 'createOrder' is not null or undefined
+            assertParamExists('createOrder', 'createOrder', createOrder)
+            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: 'POST', ...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;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -3666,6 +3979,37 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
 export const OrdersApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 
+         * @summary Confirm order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async confirmOrder(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.confirmOrder(project, platformId, orderId, confirmOrderRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.confirmOrder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Create order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateOrder} createOrder Create Order schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(project, platformId, createOrder, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -3821,6 +4165,26 @@ export const OrdersApiFp = function(configuration?: Configuration) {
 export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = OrdersApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Confirm order
+         * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
+            return localVarFp.confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Create order
+         * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
+            return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
+        },
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -3914,6 +4278,69 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
     };
 };
 
+/**
+ * Request parameters for confirmOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiConfirmOrderRequest
+ */
+export interface OrdersApiConfirmOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly platformId: string
+
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly orderId: string
+
+    /**
+     * ConfirmFulfillment schema
+     * @type {ConfirmOrderRequest}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly confirmOrderRequest: ConfirmOrderRequest
+}
+
+/**
+ * Request parameters for createOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiCreateOrderRequest
+ */
+export interface OrdersApiCreateOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly platformId: string
+
+    /**
+     * Create Order schema
+     * @type {CreateOrder}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly createOrder: CreateOrder
+}
+
 /**
  * Request parameters for exportOrders operation in OrdersApi.
  * @export
@@ -4243,6 +4670,30 @@ export interface OrdersApiUpdateFulfillmentRequest {
  * @extends {BaseAPI}
  */
 export class OrdersApi extends BaseAPI {
+    /**
+     * 
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Export orders as a CSV file
      * @summary Export orders

package/base.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.27.0
+ * The version of the OpenAPI document: 0.28.0
  * 
  *
  * 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.27.0
+ * The version of the OpenAPI document: 0.28.0
  * 
  *
  * 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.27.0
+ * The version of the OpenAPI document: 0.28.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).