@teemill/orders 1.30.3 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +3 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -2
- package/api.ts +49 -9
- package/base.ts +1 -1
- package/common.ts +15 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +45 -9
- package/dist/api.js +13 -6
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +6 -1
- package/dist/common.js +15 -4
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +45 -9
- package/dist/esm/api.js +12 -5
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +6 -1
- package/dist/esm/common.js +13 -3
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +4 -4
- package/docs/OrdersListMetaFilters.md +25 -0
- package/docs/OrdersResponse.md +4 -2
- package/docs/OrdersResponseMeta.md +21 -0
- package/docs/VatRegisteredFilterOption.md +11 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -42,7 +42,9 @@ docs/OrderItem.md
|
|
|
42
42
|
docs/OrderPaymentMethod.md
|
|
43
43
|
docs/OrderTracking.md
|
|
44
44
|
docs/OrdersApi.md
|
|
45
|
+
docs/OrdersListMetaFilters.md
|
|
45
46
|
docs/OrdersResponse.md
|
|
47
|
+
docs/OrdersResponseMeta.md
|
|
46
48
|
docs/Origin.md
|
|
47
49
|
docs/PaymentAttempt.md
|
|
48
50
|
docs/Price.md
|
|
@@ -54,6 +56,7 @@ docs/Status.md
|
|
|
54
56
|
docs/StatusHistoryItem.md
|
|
55
57
|
docs/StockConflictError.md
|
|
56
58
|
docs/StockUnavailableError.md
|
|
59
|
+
docs/VatRegisteredFilterOption.md
|
|
57
60
|
git_push.sh
|
|
58
61
|
index.ts
|
|
59
62
|
package.json
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.23.0
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/orders@1.
|
|
1
|
+
## @teemill/orders@1.31.0
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/orders@1.
|
|
39
|
+
npm install @teemill/orders@1.31.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -103,7 +103,9 @@ Class | Method | HTTP request | Description
|
|
|
103
103
|
- [OrderItem](docs/OrderItem.md)
|
|
104
104
|
- [OrderPaymentMethod](docs/OrderPaymentMethod.md)
|
|
105
105
|
- [OrderTracking](docs/OrderTracking.md)
|
|
106
|
+
- [OrdersListMetaFilters](docs/OrdersListMetaFilters.md)
|
|
106
107
|
- [OrdersResponse](docs/OrdersResponse.md)
|
|
108
|
+
- [OrdersResponseMeta](docs/OrdersResponseMeta.md)
|
|
107
109
|
- [Origin](docs/Origin.md)
|
|
108
110
|
- [PaymentAttempt](docs/PaymentAttempt.md)
|
|
109
111
|
- [Price](docs/Price.md)
|
|
@@ -115,6 +117,7 @@ Class | Method | HTTP request | Description
|
|
|
115
117
|
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
|
116
118
|
- [StockConflictError](docs/StockConflictError.md)
|
|
117
119
|
- [StockUnavailableError](docs/StockUnavailableError.md)
|
|
120
|
+
- [VatRegisteredFilterOption](docs/VatRegisteredFilterOption.md)
|
|
118
121
|
|
|
119
122
|
|
|
120
123
|
<a id="documentation-for-authorization"></a>
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -433,6 +433,10 @@ export interface Order {
|
|
|
433
433
|
* The address the order will be shipped to.
|
|
434
434
|
*/
|
|
435
435
|
'shippingAddress': Address;
|
|
436
|
+
/**
|
|
437
|
+
* The customer\'s VAT registration number for B2B orders.
|
|
438
|
+
*/
|
|
439
|
+
'vatNumber'?: string;
|
|
436
440
|
'customsInformation'?: CustomsInformation1;
|
|
437
441
|
/**
|
|
438
442
|
* When the order was created.
|
|
@@ -749,12 +753,36 @@ export interface OrderTracking {
|
|
|
749
753
|
*/
|
|
750
754
|
'url'?: string;
|
|
751
755
|
}
|
|
756
|
+
/**
|
|
757
|
+
* Filters that may be applied via `key:value` tags in the `search` query parameter. Each property name is a filter key; its value lists the allowed options for that filter on this project. Keys omitted from this object are not available for the current project.
|
|
758
|
+
*/
|
|
759
|
+
export interface OrdersListMetaFilters {
|
|
760
|
+
/**
|
|
761
|
+
* Project-specific subset of the `Status` enum. Use as `status:<code>` search tags; only values listed here are valid for the current project.
|
|
762
|
+
*/
|
|
763
|
+
'status'?: Array<Status>;
|
|
764
|
+
/**
|
|
765
|
+
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
766
|
+
*/
|
|
767
|
+
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
768
|
+
/**
|
|
769
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
770
|
+
*/
|
|
771
|
+
'sources'?: Array<string>;
|
|
772
|
+
}
|
|
752
773
|
export interface OrdersResponse {
|
|
753
|
-
'orders'
|
|
774
|
+
'orders': Array<Order>;
|
|
775
|
+
'meta': OrdersResponseMeta;
|
|
754
776
|
/**
|
|
755
777
|
* The token referencing the next page number
|
|
756
778
|
*/
|
|
757
|
-
'nextPageToken'
|
|
779
|
+
'nextPageToken': number | null;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* Metadata about the orders list, including available filters.
|
|
783
|
+
*/
|
|
784
|
+
export interface OrdersResponseMeta {
|
|
785
|
+
'filters': OrdersListMetaFilters;
|
|
758
786
|
}
|
|
759
787
|
/**
|
|
760
788
|
* The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
|
|
@@ -1002,6 +1030,18 @@ export const StockUnavailableErrorCodeEnum = {
|
|
|
1002
1030
|
|
|
1003
1031
|
export type StockUnavailableErrorCodeEnum = typeof StockUnavailableErrorCodeEnum[keyof typeof StockUnavailableErrorCodeEnum];
|
|
1004
1032
|
|
|
1033
|
+
/**
|
|
1034
|
+
* Whether a billing VAT number was provided.
|
|
1035
|
+
*/
|
|
1036
|
+
|
|
1037
|
+
export const VatRegisteredFilterOption = {
|
|
1038
|
+
True: 'true',
|
|
1039
|
+
False: 'false',
|
|
1040
|
+
} as const;
|
|
1041
|
+
|
|
1042
|
+
export type VatRegisteredFilterOption = typeof VatRegisteredFilterOption[keyof typeof VatRegisteredFilterOption];
|
|
1043
|
+
|
|
1044
|
+
|
|
1005
1045
|
|
|
1006
1046
|
/**
|
|
1007
1047
|
* OrdersApi - axios parameter creator
|
|
@@ -1227,7 +1267,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1227
1267
|
* @param {string} project The project identifier to scope the request to.
|
|
1228
1268
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1229
1269
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1230
|
-
* @param {string} [search] Search
|
|
1270
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1231
1271
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1232
1272
|
* @param {*} [options] Override http request option.
|
|
1233
1273
|
* @throws {RequiredError}
|
|
@@ -1399,7 +1439,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1399
1439
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1400
1440
|
* @param {number} [pageToken] Page reference token
|
|
1401
1441
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1402
|
-
* @param {string} [search] Search
|
|
1442
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1403
1443
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1404
1444
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1405
1445
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1779,7 +1819,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1779
1819
|
* @param {string} project The project identifier to scope the request to.
|
|
1780
1820
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1781
1821
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1782
|
-
* @param {string} [search] Search
|
|
1822
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1783
1823
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1784
1824
|
* @param {*} [options] Override http request option.
|
|
1785
1825
|
* @throws {RequiredError}
|
|
@@ -1826,7 +1866,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1826
1866
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1827
1867
|
* @param {number} [pageToken] Page reference token
|
|
1828
1868
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1829
|
-
* @param {string} [search] Search
|
|
1869
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1830
1870
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1831
1871
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1832
1872
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -2133,7 +2173,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2133
2173
|
readonly end?: string
|
|
2134
2174
|
|
|
2135
2175
|
/**
|
|
2136
|
-
* Search
|
|
2176
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
2137
2177
|
*/
|
|
2138
2178
|
readonly search?: string
|
|
2139
2179
|
|
|
@@ -2203,7 +2243,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
2203
2243
|
readonly pageSize?: number
|
|
2204
2244
|
|
|
2205
2245
|
/**
|
|
2206
|
-
* Search
|
|
2246
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
2207
2247
|
*/
|
|
2208
2248
|
readonly search?: string
|
|
2209
2249
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -86,7 +86,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
|
|
|
86
86
|
function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
|
|
87
87
|
if (parameter == null) return;
|
|
88
88
|
if (typeof parameter === "object") {
|
|
89
|
-
if (Array.isArray(parameter)) {
|
|
89
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
90
90
|
(parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
91
91
|
}
|
|
92
92
|
else {
|
|
@@ -115,6 +115,18 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
|
|
|
115
115
|
url.search = searchParams.toString();
|
|
116
116
|
}
|
|
117
117
|
|
|
118
|
+
/**
|
|
119
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
120
|
+
* @export
|
|
121
|
+
*/
|
|
122
|
+
export const replaceWithSerializableTypeIfNeeded = function (_key: string, value: unknown) {
|
|
123
|
+
if (value instanceof Set) {
|
|
124
|
+
return Array.from(value);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return value;
|
|
128
|
+
}
|
|
129
|
+
|
|
118
130
|
/**
|
|
119
131
|
*
|
|
120
132
|
* @export
|
|
@@ -125,7 +137,7 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
|
|
|
125
137
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
126
138
|
: nonString;
|
|
127
139
|
return needsSerialization
|
|
128
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
140
|
+
? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
|
|
129
141
|
: (value || "");
|
|
130
142
|
}
|
|
131
143
|
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Orders
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.31.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -413,6 +413,10 @@ export interface Order {
|
|
|
413
413
|
* The address the order will be shipped to.
|
|
414
414
|
*/
|
|
415
415
|
'shippingAddress': Address;
|
|
416
|
+
/**
|
|
417
|
+
* The customer\'s VAT registration number for B2B orders.
|
|
418
|
+
*/
|
|
419
|
+
'vatNumber'?: string;
|
|
416
420
|
'customsInformation'?: CustomsInformation1;
|
|
417
421
|
/**
|
|
418
422
|
* When the order was created.
|
|
@@ -709,12 +713,36 @@ export interface OrderTracking {
|
|
|
709
713
|
*/
|
|
710
714
|
'url'?: string;
|
|
711
715
|
}
|
|
716
|
+
/**
|
|
717
|
+
* Filters that may be applied via `key:value` tags in the `search` query parameter. Each property name is a filter key; its value lists the allowed options for that filter on this project. Keys omitted from this object are not available for the current project.
|
|
718
|
+
*/
|
|
719
|
+
export interface OrdersListMetaFilters {
|
|
720
|
+
/**
|
|
721
|
+
* Project-specific subset of the `Status` enum. Use as `status:<code>` search tags; only values listed here are valid for the current project.
|
|
722
|
+
*/
|
|
723
|
+
'status'?: Array<Status>;
|
|
724
|
+
/**
|
|
725
|
+
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
726
|
+
*/
|
|
727
|
+
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
728
|
+
/**
|
|
729
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
730
|
+
*/
|
|
731
|
+
'sources'?: Array<string>;
|
|
732
|
+
}
|
|
712
733
|
export interface OrdersResponse {
|
|
713
|
-
'orders'
|
|
734
|
+
'orders': Array<Order>;
|
|
735
|
+
'meta': OrdersResponseMeta;
|
|
714
736
|
/**
|
|
715
737
|
* The token referencing the next page number
|
|
716
738
|
*/
|
|
717
|
-
'nextPageToken'
|
|
739
|
+
'nextPageToken': number | null;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Metadata about the orders list, including available filters.
|
|
743
|
+
*/
|
|
744
|
+
export interface OrdersResponseMeta {
|
|
745
|
+
'filters': OrdersListMetaFilters;
|
|
718
746
|
}
|
|
719
747
|
/**
|
|
720
748
|
* The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
|
|
@@ -948,6 +976,14 @@ export declare const StockUnavailableErrorCodeEnum: {
|
|
|
948
976
|
readonly StockUnavailable: "STOCK_UNAVAILABLE";
|
|
949
977
|
};
|
|
950
978
|
export type StockUnavailableErrorCodeEnum = typeof StockUnavailableErrorCodeEnum[keyof typeof StockUnavailableErrorCodeEnum];
|
|
979
|
+
/**
|
|
980
|
+
* Whether a billing VAT number was provided.
|
|
981
|
+
*/
|
|
982
|
+
export declare const VatRegisteredFilterOption: {
|
|
983
|
+
readonly True: "true";
|
|
984
|
+
readonly False: "false";
|
|
985
|
+
};
|
|
986
|
+
export type VatRegisteredFilterOption = typeof VatRegisteredFilterOption[keyof typeof VatRegisteredFilterOption];
|
|
951
987
|
/**
|
|
952
988
|
* OrdersApi - axios parameter creator
|
|
953
989
|
*/
|
|
@@ -998,7 +1034,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
998
1034
|
* @param {string} project The project identifier to scope the request to.
|
|
999
1035
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1000
1036
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1001
|
-
* @param {string} [search] Search
|
|
1037
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1002
1038
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1003
1039
|
* @param {*} [options] Override http request option.
|
|
1004
1040
|
* @throws {RequiredError}
|
|
@@ -1030,7 +1066,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1030
1066
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1031
1067
|
* @param {number} [pageToken] Page reference token
|
|
1032
1068
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1033
|
-
* @param {string} [search] Search
|
|
1069
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1034
1070
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1035
1071
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1036
1072
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1131,7 +1167,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1131
1167
|
* @param {string} project The project identifier to scope the request to.
|
|
1132
1168
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1133
1169
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1134
|
-
* @param {string} [search] Search
|
|
1170
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1135
1171
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1136
1172
|
* @param {*} [options] Override http request option.
|
|
1137
1173
|
* @throws {RequiredError}
|
|
@@ -1163,7 +1199,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1163
1199
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1164
1200
|
* @param {number} [pageToken] Page reference token
|
|
1165
1201
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1166
|
-
* @param {string} [search] Search
|
|
1202
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1167
1203
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1168
1204
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1169
1205
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1400,7 +1436,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
1400
1436
|
*/
|
|
1401
1437
|
readonly end?: string;
|
|
1402
1438
|
/**
|
|
1403
|
-
* Search
|
|
1439
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1404
1440
|
*/
|
|
1405
1441
|
readonly search?: string;
|
|
1406
1442
|
/**
|
|
@@ -1459,7 +1495,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1459
1495
|
*/
|
|
1460
1496
|
readonly pageSize?: number;
|
|
1461
1497
|
/**
|
|
1462
|
-
* Search
|
|
1498
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1463
1499
|
*/
|
|
1464
1500
|
readonly search?: string;
|
|
1465
1501
|
/**
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.FulfillmentFrozenReasonsEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
25
|
+
exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.VatRegisteredFilterOption = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.FulfillmentFrozenReasonsEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -112,6 +112,13 @@ exports.Status = {
|
|
|
112
112
|
exports.StockUnavailableErrorCodeEnum = {
|
|
113
113
|
StockUnavailable: 'STOCK_UNAVAILABLE',
|
|
114
114
|
};
|
|
115
|
+
/**
|
|
116
|
+
* Whether a billing VAT number was provided.
|
|
117
|
+
*/
|
|
118
|
+
exports.VatRegisteredFilterOption = {
|
|
119
|
+
True: 'true',
|
|
120
|
+
False: 'false',
|
|
121
|
+
};
|
|
115
122
|
/**
|
|
116
123
|
* OrdersApi - axios parameter creator
|
|
117
124
|
*/
|
|
@@ -305,7 +312,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
305
312
|
* @param {string} project The project identifier to scope the request to.
|
|
306
313
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
307
314
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
308
|
-
* @param {string} [search] Search
|
|
315
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
309
316
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
310
317
|
* @param {*} [options] Override http request option.
|
|
311
318
|
* @throws {RequiredError}
|
|
@@ -451,7 +458,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
451
458
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
452
459
|
* @param {number} [pageToken] Page reference token
|
|
453
460
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
454
|
-
* @param {string} [search] Search
|
|
461
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
455
462
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
456
463
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
457
464
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -793,7 +800,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
793
800
|
* @param {string} project The project identifier to scope the request to.
|
|
794
801
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
795
802
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
796
|
-
* @param {string} [search] Search
|
|
803
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
797
804
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
798
805
|
* @param {*} [options] Override http request option.
|
|
799
806
|
* @throws {RequiredError}
|
|
@@ -849,7 +856,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
849
856
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
850
857
|
* @param {number} [pageToken] Page reference token
|
|
851
858
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
852
|
-
* @param {string} [search] Search
|
|
859
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
853
860
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
854
861
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
855
862
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -48,6 +48,11 @@ export declare const setOAuthToObject: (object: any, name: string, scopes: strin
|
|
|
48
48
|
* @export
|
|
49
49
|
*/
|
|
50
50
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const replaceWithSerializableTypeIfNeeded: (_key: string, value: unknown) => unknown;
|
|
51
56
|
/**
|
|
52
57
|
*
|
|
53
58
|
* @export
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
|
|
25
|
+
exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
|
|
26
26
|
const base_1 = require("./base");
|
|
27
27
|
/**
|
|
28
28
|
*
|
|
@@ -99,7 +99,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
99
99
|
if (parameter == null)
|
|
100
100
|
return;
|
|
101
101
|
if (typeof parameter === "object") {
|
|
102
|
-
if (Array.isArray(parameter)) {
|
|
102
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
103
103
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
104
104
|
}
|
|
105
105
|
else {
|
|
@@ -125,6 +125,17 @@ const setSearchParams = function (url, ...objects) {
|
|
|
125
125
|
url.search = searchParams.toString();
|
|
126
126
|
};
|
|
127
127
|
exports.setSearchParams = setSearchParams;
|
|
128
|
+
/**
|
|
129
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
130
|
+
* @export
|
|
131
|
+
*/
|
|
132
|
+
const replaceWithSerializableTypeIfNeeded = function (_key, value) {
|
|
133
|
+
if (value instanceof Set) {
|
|
134
|
+
return Array.from(value);
|
|
135
|
+
}
|
|
136
|
+
return value;
|
|
137
|
+
};
|
|
138
|
+
exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
|
|
128
139
|
/**
|
|
129
140
|
*
|
|
130
141
|
* @export
|
|
@@ -135,7 +146,7 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
|
135
146
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
136
147
|
: nonString;
|
|
137
148
|
return needsSerialization
|
|
138
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
149
|
+
? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
|
|
139
150
|
: (value || "");
|
|
140
151
|
};
|
|
141
152
|
exports.serializeDataIfNeeded = serializeDataIfNeeded;
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -413,6 +413,10 @@ export interface Order {
|
|
|
413
413
|
* The address the order will be shipped to.
|
|
414
414
|
*/
|
|
415
415
|
'shippingAddress': Address;
|
|
416
|
+
/**
|
|
417
|
+
* The customer\'s VAT registration number for B2B orders.
|
|
418
|
+
*/
|
|
419
|
+
'vatNumber'?: string;
|
|
416
420
|
'customsInformation'?: CustomsInformation1;
|
|
417
421
|
/**
|
|
418
422
|
* When the order was created.
|
|
@@ -709,12 +713,36 @@ export interface OrderTracking {
|
|
|
709
713
|
*/
|
|
710
714
|
'url'?: string;
|
|
711
715
|
}
|
|
716
|
+
/**
|
|
717
|
+
* Filters that may be applied via `key:value` tags in the `search` query parameter. Each property name is a filter key; its value lists the allowed options for that filter on this project. Keys omitted from this object are not available for the current project.
|
|
718
|
+
*/
|
|
719
|
+
export interface OrdersListMetaFilters {
|
|
720
|
+
/**
|
|
721
|
+
* Project-specific subset of the `Status` enum. Use as `status:<code>` search tags; only values listed here are valid for the current project.
|
|
722
|
+
*/
|
|
723
|
+
'status'?: Array<Status>;
|
|
724
|
+
/**
|
|
725
|
+
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
726
|
+
*/
|
|
727
|
+
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
728
|
+
/**
|
|
729
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
730
|
+
*/
|
|
731
|
+
'sources'?: Array<string>;
|
|
732
|
+
}
|
|
712
733
|
export interface OrdersResponse {
|
|
713
|
-
'orders'
|
|
734
|
+
'orders': Array<Order>;
|
|
735
|
+
'meta': OrdersResponseMeta;
|
|
714
736
|
/**
|
|
715
737
|
* The token referencing the next page number
|
|
716
738
|
*/
|
|
717
|
-
'nextPageToken'
|
|
739
|
+
'nextPageToken': number | null;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Metadata about the orders list, including available filters.
|
|
743
|
+
*/
|
|
744
|
+
export interface OrdersResponseMeta {
|
|
745
|
+
'filters': OrdersListMetaFilters;
|
|
718
746
|
}
|
|
719
747
|
/**
|
|
720
748
|
* The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
|
|
@@ -948,6 +976,14 @@ export declare const StockUnavailableErrorCodeEnum: {
|
|
|
948
976
|
readonly StockUnavailable: "STOCK_UNAVAILABLE";
|
|
949
977
|
};
|
|
950
978
|
export type StockUnavailableErrorCodeEnum = typeof StockUnavailableErrorCodeEnum[keyof typeof StockUnavailableErrorCodeEnum];
|
|
979
|
+
/**
|
|
980
|
+
* Whether a billing VAT number was provided.
|
|
981
|
+
*/
|
|
982
|
+
export declare const VatRegisteredFilterOption: {
|
|
983
|
+
readonly True: "true";
|
|
984
|
+
readonly False: "false";
|
|
985
|
+
};
|
|
986
|
+
export type VatRegisteredFilterOption = typeof VatRegisteredFilterOption[keyof typeof VatRegisteredFilterOption];
|
|
951
987
|
/**
|
|
952
988
|
* OrdersApi - axios parameter creator
|
|
953
989
|
*/
|
|
@@ -998,7 +1034,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
998
1034
|
* @param {string} project The project identifier to scope the request to.
|
|
999
1035
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1000
1036
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1001
|
-
* @param {string} [search] Search
|
|
1037
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1002
1038
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1003
1039
|
* @param {*} [options] Override http request option.
|
|
1004
1040
|
* @throws {RequiredError}
|
|
@@ -1030,7 +1066,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1030
1066
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1031
1067
|
* @param {number} [pageToken] Page reference token
|
|
1032
1068
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1033
|
-
* @param {string} [search] Search
|
|
1069
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1034
1070
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1035
1071
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1036
1072
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1131,7 +1167,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1131
1167
|
* @param {string} project The project identifier to scope the request to.
|
|
1132
1168
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1133
1169
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1134
|
-
* @param {string} [search] Search
|
|
1170
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1135
1171
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1136
1172
|
* @param {*} [options] Override http request option.
|
|
1137
1173
|
* @throws {RequiredError}
|
|
@@ -1163,7 +1199,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1163
1199
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1164
1200
|
* @param {number} [pageToken] Page reference token
|
|
1165
1201
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1166
|
-
* @param {string} [search] Search
|
|
1202
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1167
1203
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1168
1204
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1169
1205
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1400,7 +1436,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
1400
1436
|
*/
|
|
1401
1437
|
readonly end?: string;
|
|
1402
1438
|
/**
|
|
1403
|
-
* Search
|
|
1439
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1404
1440
|
*/
|
|
1405
1441
|
readonly search?: string;
|
|
1406
1442
|
/**
|
|
@@ -1459,7 +1495,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1459
1495
|
*/
|
|
1460
1496
|
readonly pageSize?: number;
|
|
1461
1497
|
/**
|
|
1462
|
-
* Search
|
|
1498
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1463
1499
|
*/
|
|
1464
1500
|
readonly search?: string;
|
|
1465
1501
|
/**
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -109,6 +109,13 @@ export const Status = {
|
|
|
109
109
|
export const StockUnavailableErrorCodeEnum = {
|
|
110
110
|
StockUnavailable: 'STOCK_UNAVAILABLE',
|
|
111
111
|
};
|
|
112
|
+
/**
|
|
113
|
+
* Whether a billing VAT number was provided.
|
|
114
|
+
*/
|
|
115
|
+
export const VatRegisteredFilterOption = {
|
|
116
|
+
True: 'true',
|
|
117
|
+
False: 'false',
|
|
118
|
+
};
|
|
112
119
|
/**
|
|
113
120
|
* OrdersApi - axios parameter creator
|
|
114
121
|
*/
|
|
@@ -302,7 +309,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
302
309
|
* @param {string} project The project identifier to scope the request to.
|
|
303
310
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
304
311
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
305
|
-
* @param {string} [search] Search
|
|
312
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
306
313
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
307
314
|
* @param {*} [options] Override http request option.
|
|
308
315
|
* @throws {RequiredError}
|
|
@@ -448,7 +455,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
448
455
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
449
456
|
* @param {number} [pageToken] Page reference token
|
|
450
457
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
451
|
-
* @param {string} [search] Search
|
|
458
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
452
459
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
453
460
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
454
461
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -789,7 +796,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
789
796
|
* @param {string} project The project identifier to scope the request to.
|
|
790
797
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
791
798
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
792
|
-
* @param {string} [search] Search
|
|
799
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
793
800
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
794
801
|
* @param {*} [options] Override http request option.
|
|
795
802
|
* @throws {RequiredError}
|
|
@@ -845,7 +852,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
845
852
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
846
853
|
* @param {number} [pageToken] Page reference token
|
|
847
854
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
848
|
-
* @param {string} [search] Search
|
|
855
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
849
856
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
850
857
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
851
858
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -48,6 +48,11 @@ export declare const setOAuthToObject: (object: any, name: string, scopes: strin
|
|
|
48
48
|
* @export
|
|
49
49
|
*/
|
|
50
50
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const replaceWithSerializableTypeIfNeeded: (_key: string, value: unknown) => unknown;
|
|
51
56
|
/**
|
|
52
57
|
*
|
|
53
58
|
* @export
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -91,7 +91,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
91
91
|
if (parameter == null)
|
|
92
92
|
return;
|
|
93
93
|
if (typeof parameter === "object") {
|
|
94
|
-
if (Array.isArray(parameter)) {
|
|
94
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
95
95
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
96
96
|
}
|
|
97
97
|
else {
|
|
@@ -116,6 +116,16 @@ export const setSearchParams = function (url, ...objects) {
|
|
|
116
116
|
setFlattenedQueryParams(searchParams, objects);
|
|
117
117
|
url.search = searchParams.toString();
|
|
118
118
|
};
|
|
119
|
+
/**
|
|
120
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
121
|
+
* @export
|
|
122
|
+
*/
|
|
123
|
+
export const replaceWithSerializableTypeIfNeeded = function (_key, value) {
|
|
124
|
+
if (value instanceof Set) {
|
|
125
|
+
return Array.from(value);
|
|
126
|
+
}
|
|
127
|
+
return value;
|
|
128
|
+
};
|
|
119
129
|
/**
|
|
120
130
|
*
|
|
121
131
|
* @export
|
|
@@ -126,7 +136,7 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
|
|
|
126
136
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
127
137
|
: nonString;
|
|
128
138
|
return needsSerialization
|
|
129
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
139
|
+
? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
|
|
130
140
|
: (value || "");
|
|
131
141
|
};
|
|
132
142
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Orders
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.31.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Order.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
13
13
|
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
14
14
|
**shippingAddress** | [**Address**](Address.md) | The address the order will be shipped to. | [default to undefined]
|
|
15
|
+
**vatNumber** | **string** | The customer\'s VAT registration number for B2B orders. | [optional] [default to undefined]
|
|
15
16
|
**customsInformation** | [**CustomsInformation1**](CustomsInformation1.md) | | [optional] [default to undefined]
|
|
16
17
|
**createdAt** | **string** | When the order was created. | [optional] [default to undefined]
|
|
17
18
|
**updatedAt** | **string** | When the order was last updated. | [optional] [default to undefined]
|
|
@@ -41,6 +42,7 @@ const instance: Order = {
|
|
|
41
42
|
contactInformation,
|
|
42
43
|
paymentMethod,
|
|
43
44
|
shippingAddress,
|
|
45
|
+
vatNumber,
|
|
44
46
|
customsInformation,
|
|
45
47
|
createdAt,
|
|
46
48
|
updatedAt,
|
package/docs/OrdersApi.md
CHANGED
|
@@ -285,7 +285,7 @@ const apiInstance = new OrdersApi(configuration);
|
|
|
285
285
|
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
286
286
|
let start: string; //Start of the date range to filter by when orders were placed. (default to undefined)
|
|
287
287
|
let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
288
|
-
let search: string; //Search
|
|
288
|
+
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` (optional) (default to undefined)
|
|
289
289
|
let dateFilterType: 'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
290
290
|
|
|
291
291
|
const { status, data } = await apiInstance.exportOrders(
|
|
@@ -304,7 +304,7 @@ const { status, data } = await apiInstance.exportOrders(
|
|
|
304
304
|
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
305
305
|
| **start** | [**string**] | Start of the date range to filter by when orders were placed. | defaults to undefined|
|
|
306
306
|
| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
307
|
-
| **search** | [**string**] | Search
|
|
307
|
+
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` | (optional) defaults to undefined|
|
|
308
308
|
| **dateFilterType** | [**'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'**]**Array<'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
309
309
|
|
|
310
310
|
|
|
@@ -476,7 +476,7 @@ let project: string; //The project identifier to scope the request to. (default
|
|
|
476
476
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
477
477
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
478
478
|
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
479
|
-
let search: string; //Search
|
|
479
|
+
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` (optional) (default to undefined)
|
|
480
480
|
let ids: Array<string>; //Filter to specific order IDs. Only orders matching these IDs will be returned. (optional) (default to undefined)
|
|
481
481
|
let statuses: Array<Status>; //Filter by order status. Only orders matching one of the given statuses will be returned. (optional) (default to undefined)
|
|
482
482
|
let start: string; //Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
@@ -505,7 +505,7 @@ const { status, data } = await apiInstance.getOrders(
|
|
|
505
505
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
506
506
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
507
507
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
508
|
-
| **search** | [**string**] | Search
|
|
508
|
+
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` | (optional) defaults to undefined|
|
|
509
509
|
| **ids** | **Array<string>** | Filter to specific order IDs. Only orders matching these IDs will be returned. | (optional) defaults to undefined|
|
|
510
510
|
| **statuses** | **Array<Status>** | Filter by order status. Only orders matching one of the given statuses will be returned. | (optional) defaults to undefined|
|
|
511
511
|
| **start** | [**string**] | Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrdersListMetaFilters
|
|
2
|
+
|
|
3
|
+
Filters that may be applied via `key:value` tags in the `search` query parameter. Each property name is a filter key; its value lists the allowed options for that filter on this project. Keys omitted from this object are not available for the current project.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**status** | [**Array<Status>**](Status.md) | Project-specific subset of the `Status` enum. Use as `status:<code>` search tags; only values listed here are valid for the current project. | [optional] [default to undefined]
|
|
10
|
+
**vatRegistered** | [**Array<VatRegisteredFilterOption>**](VatRegisteredFilterOption.md) | When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available. | [optional] [default to undefined]
|
|
11
|
+
**sources** | **Array<string>** | Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrdersListMetaFilters } from '@teemill/orders';
|
|
17
|
+
|
|
18
|
+
const instance: OrdersListMetaFilters = {
|
|
19
|
+
status,
|
|
20
|
+
vatRegistered,
|
|
21
|
+
sources,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OrdersResponse.md
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**orders** | [**Array<Order>**](Order.md) | | [
|
|
9
|
-
**
|
|
8
|
+
**orders** | [**Array<Order>**](Order.md) | | [default to undefined]
|
|
9
|
+
**meta** | [**OrdersResponseMeta**](OrdersResponseMeta.md) | | [default to undefined]
|
|
10
|
+
**nextPageToken** | **number** | The token referencing the next page number | [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -15,6 +16,7 @@ import { OrdersResponse } from '@teemill/orders';
|
|
|
15
16
|
|
|
16
17
|
const instance: OrdersResponse = {
|
|
17
18
|
orders,
|
|
19
|
+
meta,
|
|
18
20
|
nextPageToken,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# OrdersResponseMeta
|
|
2
|
+
|
|
3
|
+
Metadata about the orders list, including available filters.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**filters** | [**OrdersListMetaFilters**](OrdersListMetaFilters.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { OrdersResponseMeta } from '@teemill/orders';
|
|
15
|
+
|
|
16
|
+
const instance: OrdersResponseMeta = {
|
|
17
|
+
filters,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# VatRegisteredFilterOption
|
|
2
|
+
|
|
3
|
+
Whether a billing VAT number was provided.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `True` (value: `'true'`)
|
|
8
|
+
|
|
9
|
+
* `False` (value: `'false'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|