@teemill/platform 0.26.0 → 0.28.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -112,6 +112,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
@@ -176,6 +227,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
@@ -244,6 +363,41 @@ 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 declare const CustomsInformationPreRegistrationTypeEnum: {
+    readonly Ioss: "IOSS";
+};
+export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
 /**
  *
  * @export
@@ -967,6 +1121,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
@@ -2508,6 +2706,27 @@ export declare class EnquiriesApi extends BaseAPI {
  * @export
  */
 export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: (project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2571,10 +2790,12 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} [start] Start of date range to filter when orders were placed
      * @param {string} [end] End of date range to filter when orders were placed
      * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     * @param {number} [maxOrderTotal] The maximum value of the order
+     * @param {number} [minOrderTotal] The minimum value of the order
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -2612,6 +2833,27 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const OrdersApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     *
+     * @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(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2675,10 +2917,12 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @param {string} [start] Start of date range to filter when orders were placed
      * @param {string} [end] End of date range to filter when orders were placed
      * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     * @param {number} [maxOrderTotal] The maximum value of the order
+     * @param {number} [minOrderTotal] The minimum value of the order
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
+    listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
     /**
      * Retries failed platform payment, so fulfillment can proceed.
      * @summary Retry
@@ -2716,6 +2960,22 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     *
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -2789,6 +3049,62 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      */
     updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
 };
+/**
+ * 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
@@ -2980,6 +3296,18 @@ export interface OrdersApiListOrdersRequest {
      * @memberof OrdersApiListOrders
      */
     readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
+    /**
+     * The maximum value of the order
+     * @type {number}
+     * @memberof OrdersApiListOrders
+     */
+    readonly maxOrderTotal?: number;
+    /**
+     * The minimum value of the order
+     * @type {number}
+     * @memberof OrdersApiListOrders
+     */
+    readonly minOrderTotal?: number;
 }
 /**
  * Request parameters for retryPlatformPayment operation in OrdersApi.
@@ -3069,6 +3397,24 @@ export interface OrdersApiUpdateFulfillmentRequest {
  * @extends {BaseAPI}
  */
 export declare class OrdersApi extends BaseAPI {
+    /**
+     *
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     *
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
     /**
      * Export orders as a CSV file
      * @summary Export orders