@teemill/orders 1.11.0 → 1.13.1

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Orders API
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.  For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
  *
- * The version of the OpenAPI document: 1.11.0
+ * The version of the OpenAPI document: 1.13.1
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,7 +24,7 @@ export interface Address {
      * @type {string}
      * @memberof Address
      */
-    'contactName': string;
+    'contactName'?: string;
     /**
      *
      * @type {string}
@@ -36,7 +36,7 @@ export interface Address {
      * @type {string}
      * @memberof Address
      */
-    'line1': string;
+    'line1'?: string;
     /**
      * Second line of the address.
      * @type {string}
@@ -48,7 +48,7 @@ export interface Address {
      * @type {string}
      * @memberof Address
      */
-    'city': string;
+    'city'?: string;
     /**
      * Postal code of the address.
      * @type {string}
@@ -62,7 +62,7 @@ export interface Address {
      */
     'country': string;
     /**
-     * State of the address.
+     * State of the address. If the country is Canada, Australia, or the United States, this field is required.
      * @type {string}
      * @memberof Address
      */
@@ -164,6 +164,128 @@ export interface ContactInformation {
      */
     'phone'?: string | null;
 }
+/**
+ * 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>;
+}
+/**
+ * Contact information for the order
+ * @export
+ * @interface CreateOrderContactInformation
+ */
+export interface CreateOrderContactInformation {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateOrderContactInformation
+     */
+    'email': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateOrderContactInformation
+     */
+    'phone'?: string | null;
+}
+/**
+ *
+ * @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
+ * @interface CustomsInformation1
+ */
+export interface CustomsInformation1 {
+    /**
+     *
+     * @type {string}
+     * @memberof CustomsInformation1
+     */
+    'preRegistrationType'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomsInformation1
+     */
+    'preRegistrationNumber'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomsInformation1
+     */
+    'vatNumber'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomsInformation1
+     */
+    'eoriNumber'?: string;
+}
 /**
  *
  * @export
@@ -406,6 +528,12 @@ export interface Order {
      * @memberof Order
      */
     'shippingAddress': Address;
+    /**
+     *
+     * @type {CustomsInformation1}
+     * @memberof Order
+     */
+    'customsInformation'?: CustomsInformation1;
     /**
      * ISO 8601 Timestamp
      * @type {string}
@@ -419,7 +547,13 @@ export interface Order {
      */
     'updatedAt'?: string;
     /**
-     * A custom reference to the merchant\'s order that will be displayed on the shipping label.
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Order
+     */
+    'statusChangedAt'?: string;
+    /**
+     * A custom reference to the merchant\'s order.
      * @type {string}
      * @memberof Order
      */
@@ -552,6 +686,50 @@ export interface OrderItem {
      */
     'recipientCost'?: Price;
 }
+/**
+ *
+ * @export
+ * @interface OrderItem1
+ */
+export interface OrderItem1 {
+    /**
+     * A reference to the resource location
+     * @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
@@ -596,19 +774,6 @@ export interface OrdersResponse {
      */
     'nextPageToken'?: number;
 }
-/**
- *
- * @export
- * @interface OrdersStatusesResponse
- */
-export interface OrdersStatusesResponse {
-    /**
-     *
-     * @type {Array<Status>}
-     * @memberof OrdersStatusesResponse
-     */
-    'statuses'?: Array<Status>;
-}
 /**
  *
  * @export
@@ -765,18 +930,18 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
      * @summary Create order
      * @param {string} project What project it is
-     * @param {Order} order Order schema
+     * @param {CreateOrder} createOrder Create Order schema
      * @param {string} [fields] Specifies which fields to return, separated by commas
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createOrder: (project: string, order: Order, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    createOrder: (project: string, createOrder: CreateOrder, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
      * @param {string} project What project it is
      * @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 {string} [end] End of date range
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -802,20 +967,13 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {Array<string>} [ids] Specify fulfillment IDs to list
      * @param {Array<Status>} [statuses] Filter by fulfillment status
-     * @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 {string} [start] Start of date range
+     * @param {string} [end] End of date range
+     * @param {GetOrdersDateFilterTypeEnum} [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 {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrders: (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lists orders\' statuses and only include \'quote\' if at least one order has that status
-     * @summary List orders\' statuses
-     * @param {string} project What project it is
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatuses: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getOrders: (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * OrdersApi - functional programming interface
@@ -847,18 +1005,18 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
      * @summary Create order
      * @param {string} project What project it is
-     * @param {Order} order Order schema
+     * @param {CreateOrder} createOrder Create Order schema
      * @param {string} [fields] Specifies which fields to return, separated by commas
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createOrder(project: string, order: Order, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    createOrder(project: string, createOrder: CreateOrder, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      * Export orders as a CSV file
      * @summary Export orders
      * @param {string} project What project it is
      * @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 {string} [end] End of date range
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -884,20 +1042,13 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @param {string} [search] Search term to filter based on order reference, customer name and email
      * @param {Array<string>} [ids] Specify fulfillment IDs to list
      * @param {Array<Status>} [statuses] Filter by fulfillment status
-     * @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 {string} [start] Start of date range
+     * @param {string} [end] End of date range
+     * @param {GetOrdersDateFilterTypeEnum} [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 {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrders(project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
-    /**
-     * Lists orders\' statuses and only include \'quote\' if at least one order has that status
-     * @summary List orders\' statuses
-     * @param {string} project What project it is
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatuses(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersStatusesResponse>>;
+    getOrders(project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
 };
 /**
  * OrdersApi - factory interface
@@ -952,14 +1103,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
-    /**
-     * Lists orders\' statuses and only include \'quote\' if at least one order has that status
-     * @summary List orders\' statuses
-     * @param {OrdersApiGetStatusesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatuses(requestParameters: OrdersApiGetStatusesRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersStatusesResponse>;
 };
 /**
  * Request parameters for cancelOrder operation in OrdersApi.
@@ -1030,11 +1173,11 @@ export interface OrdersApiCreateOrderRequest {
      */
     readonly project: string;
     /**
-     * Order schema
-     * @type {Order}
+     * Create Order schema
+     * @type {CreateOrder}
      * @memberof OrdersApiCreateOrder
      */
-    readonly order: Order;
+    readonly createOrder: CreateOrder;
     /**
      * Specifies which fields to return, separated by commas
      * @type {string}
@@ -1061,7 +1204,7 @@ export interface OrdersApiExportOrdersRequest {
      */
     readonly start: string;
     /**
-     * End of date range to filter by when orders were placed
+     * End of date range
      * @type {string}
      * @memberof OrdersApiExportOrders
      */
@@ -1147,30 +1290,23 @@ export interface OrdersApiGetOrdersRequest {
      */
     readonly statuses?: Array<Status>;
     /**
-     * Start of date range to filter by when orders were placed
+     * Start of date range
      * @type {string}
      * @memberof OrdersApiGetOrders
      */
     readonly start?: string;
     /**
-     * End of date range to filter by when orders were placed
+     * End of date range
      * @type {string}
      * @memberof OrdersApiGetOrders
      */
     readonly end?: string;
-}
-/**
- * Request parameters for getStatuses operation in OrdersApi.
- * @export
- * @interface OrdersApiGetStatusesRequest
- */
-export interface OrdersApiGetStatusesRequest {
     /**
-     * What project it is
-     * @type {string}
-     * @memberof OrdersApiGetStatuses
+     * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
+     * @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
+     * @memberof OrdersApiGetOrders
      */
-    readonly project: string;
+    readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
 }
 /**
  * OrdersApi - object-oriented interface
@@ -1233,13 +1369,13 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
-    /**
-     * Lists orders\' statuses and only include \'quote\' if at least one order has that status
-     * @summary List orders\' statuses
-     * @param {OrdersApiGetStatusesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrdersApi
-     */
-    getStatuses(requestParameters: OrdersApiGetStatusesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersStatusesResponse, any>>;
 }
+/**
+ * @export
+ */
+export declare const GetOrdersDateFilterTypeEnum: {
+    readonly CreatedAt: "createdAt";
+    readonly UpdatedAt: "updatedAt";
+    readonly StatusChangedAt: "statusChangedAt";
+};
+export type GetOrdersDateFilterTypeEnum = typeof GetOrdersDateFilterTypeEnum[keyof typeof GetOrdersDateFilterTypeEnum];