@teemill/orders 1.11.0 → 1.13.1
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/README.md +2 -2
- package/api.ts +231 -134
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +217 -81
- package/dist/api.js +38 -95
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +217 -81
- package/dist/esm/api.js +37 -94
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- 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/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/orders@1.
|
|
1
|
+
## @teemill/orders@1.13.1
|
|
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.13.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
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. For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.13.1
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -34,7 +34,7 @@ export interface Address {
|
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof Address
|
|
36
36
|
*/
|
|
37
|
-
'contactName'
|
|
37
|
+
'contactName'?: string;
|
|
38
38
|
/**
|
|
39
39
|
*
|
|
40
40
|
* @type {string}
|
|
@@ -46,7 +46,7 @@ export interface Address {
|
|
|
46
46
|
* @type {string}
|
|
47
47
|
* @memberof Address
|
|
48
48
|
*/
|
|
49
|
-
'line1'
|
|
49
|
+
'line1'?: string;
|
|
50
50
|
/**
|
|
51
51
|
* Second line of the address.
|
|
52
52
|
* @type {string}
|
|
@@ -58,7 +58,7 @@ export interface Address {
|
|
|
58
58
|
* @type {string}
|
|
59
59
|
* @memberof Address
|
|
60
60
|
*/
|
|
61
|
-
'city'
|
|
61
|
+
'city'?: string;
|
|
62
62
|
/**
|
|
63
63
|
* Postal code of the address.
|
|
64
64
|
* @type {string}
|
|
@@ -72,7 +72,7 @@ export interface Address {
|
|
|
72
72
|
*/
|
|
73
73
|
'country': string;
|
|
74
74
|
/**
|
|
75
|
-
* State of the address.
|
|
75
|
+
* State of the address. If the country is Canada, Australia, or the United States, this field is required.
|
|
76
76
|
* @type {string}
|
|
77
77
|
* @memberof Address
|
|
78
78
|
*/
|
|
@@ -177,6 +177,131 @@ export interface ContactInformation {
|
|
|
177
177
|
*/
|
|
178
178
|
'phone'?: string | null;
|
|
179
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* Create an order
|
|
182
|
+
* @export
|
|
183
|
+
* @interface CreateOrder
|
|
184
|
+
*/
|
|
185
|
+
export interface CreateOrder {
|
|
186
|
+
/**
|
|
187
|
+
* A custom reference to the merchant\'s order.
|
|
188
|
+
* @type {string}
|
|
189
|
+
* @memberof CreateOrder
|
|
190
|
+
*/
|
|
191
|
+
'merchantReference'?: string | null;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {CreateOrderContactInformation}
|
|
195
|
+
* @memberof CreateOrder
|
|
196
|
+
*/
|
|
197
|
+
'contactInformation': CreateOrderContactInformation;
|
|
198
|
+
/**
|
|
199
|
+
*
|
|
200
|
+
* @type {Address}
|
|
201
|
+
* @memberof CreateOrder
|
|
202
|
+
*/
|
|
203
|
+
'shippingAddress': Address;
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {CustomsInformation}
|
|
207
|
+
* @memberof CreateOrder
|
|
208
|
+
*/
|
|
209
|
+
'customsInformation'?: CustomsInformation;
|
|
210
|
+
/**
|
|
211
|
+
* Items to be ordered
|
|
212
|
+
* @type {Array<OrderItem1>}
|
|
213
|
+
* @memberof CreateOrder
|
|
214
|
+
*/
|
|
215
|
+
'items': Array<OrderItem1>;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Contact information for the order
|
|
219
|
+
* @export
|
|
220
|
+
* @interface CreateOrderContactInformation
|
|
221
|
+
*/
|
|
222
|
+
export interface CreateOrderContactInformation {
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof CreateOrderContactInformation
|
|
227
|
+
*/
|
|
228
|
+
'email': string;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof CreateOrderContactInformation
|
|
233
|
+
*/
|
|
234
|
+
'phone'?: string | null;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
* @export
|
|
239
|
+
* @interface CustomsInformation
|
|
240
|
+
*/
|
|
241
|
+
export interface CustomsInformation {
|
|
242
|
+
/**
|
|
243
|
+
* Pre-registration type
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof CustomsInformation
|
|
246
|
+
*/
|
|
247
|
+
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
248
|
+
/**
|
|
249
|
+
* Pre-registration number
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof CustomsInformation
|
|
252
|
+
*/
|
|
253
|
+
'preRegistrationNumber'?: string;
|
|
254
|
+
/**
|
|
255
|
+
* VAT number
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof CustomsInformation
|
|
258
|
+
*/
|
|
259
|
+
'vatNumber'?: string;
|
|
260
|
+
/**
|
|
261
|
+
* EORI number
|
|
262
|
+
* @type {string}
|
|
263
|
+
* @memberof CustomsInformation
|
|
264
|
+
*/
|
|
265
|
+
'eoriNumber'?: string;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
269
|
+
Ioss: 'IOSS'
|
|
270
|
+
} as const;
|
|
271
|
+
|
|
272
|
+
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
*
|
|
276
|
+
* @export
|
|
277
|
+
* @interface CustomsInformation1
|
|
278
|
+
*/
|
|
279
|
+
export interface CustomsInformation1 {
|
|
280
|
+
/**
|
|
281
|
+
*
|
|
282
|
+
* @type {string}
|
|
283
|
+
* @memberof CustomsInformation1
|
|
284
|
+
*/
|
|
285
|
+
'preRegistrationType'?: string;
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof CustomsInformation1
|
|
290
|
+
*/
|
|
291
|
+
'preRegistrationNumber'?: string;
|
|
292
|
+
/**
|
|
293
|
+
*
|
|
294
|
+
* @type {string}
|
|
295
|
+
* @memberof CustomsInformation1
|
|
296
|
+
*/
|
|
297
|
+
'vatNumber'?: string;
|
|
298
|
+
/**
|
|
299
|
+
*
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof CustomsInformation1
|
|
302
|
+
*/
|
|
303
|
+
'eoriNumber'?: string;
|
|
304
|
+
}
|
|
180
305
|
/**
|
|
181
306
|
*
|
|
182
307
|
* @export
|
|
@@ -421,6 +546,12 @@ export interface Order {
|
|
|
421
546
|
* @memberof Order
|
|
422
547
|
*/
|
|
423
548
|
'shippingAddress': Address;
|
|
549
|
+
/**
|
|
550
|
+
*
|
|
551
|
+
* @type {CustomsInformation1}
|
|
552
|
+
* @memberof Order
|
|
553
|
+
*/
|
|
554
|
+
'customsInformation'?: CustomsInformation1;
|
|
424
555
|
/**
|
|
425
556
|
* ISO 8601 Timestamp
|
|
426
557
|
* @type {string}
|
|
@@ -434,7 +565,13 @@ export interface Order {
|
|
|
434
565
|
*/
|
|
435
566
|
'updatedAt'?: string;
|
|
436
567
|
/**
|
|
437
|
-
*
|
|
568
|
+
* ISO 8601 Timestamp
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof Order
|
|
571
|
+
*/
|
|
572
|
+
'statusChangedAt'?: string;
|
|
573
|
+
/**
|
|
574
|
+
* A custom reference to the merchant\'s order.
|
|
438
575
|
* @type {string}
|
|
439
576
|
* @memberof Order
|
|
440
577
|
*/
|
|
@@ -569,6 +706,50 @@ export interface OrderItem {
|
|
|
569
706
|
*/
|
|
570
707
|
'recipientCost'?: Price;
|
|
571
708
|
}
|
|
709
|
+
/**
|
|
710
|
+
*
|
|
711
|
+
* @export
|
|
712
|
+
* @interface OrderItem1
|
|
713
|
+
*/
|
|
714
|
+
export interface OrderItem1 {
|
|
715
|
+
/**
|
|
716
|
+
* A reference to the resource location
|
|
717
|
+
* @type {string}
|
|
718
|
+
* @memberof OrderItem1
|
|
719
|
+
*/
|
|
720
|
+
'variantRef': string;
|
|
721
|
+
/**
|
|
722
|
+
*
|
|
723
|
+
* @type {number}
|
|
724
|
+
* @memberof OrderItem1
|
|
725
|
+
*/
|
|
726
|
+
'quantity': number;
|
|
727
|
+
/**
|
|
728
|
+
*
|
|
729
|
+
* @type {OrderItem1RecipientCost}
|
|
730
|
+
* @memberof OrderItem1
|
|
731
|
+
*/
|
|
732
|
+
'recipientCost'?: OrderItem1RecipientCost;
|
|
733
|
+
}
|
|
734
|
+
/**
|
|
735
|
+
*
|
|
736
|
+
* @export
|
|
737
|
+
* @interface OrderItem1RecipientCost
|
|
738
|
+
*/
|
|
739
|
+
export interface OrderItem1RecipientCost {
|
|
740
|
+
/**
|
|
741
|
+
*
|
|
742
|
+
* @type {string}
|
|
743
|
+
* @memberof OrderItem1RecipientCost
|
|
744
|
+
*/
|
|
745
|
+
'amount': string;
|
|
746
|
+
/**
|
|
747
|
+
*
|
|
748
|
+
* @type {string}
|
|
749
|
+
* @memberof OrderItem1RecipientCost
|
|
750
|
+
*/
|
|
751
|
+
'currencyCode': string;
|
|
752
|
+
}
|
|
572
753
|
/**
|
|
573
754
|
*
|
|
574
755
|
* @export
|
|
@@ -613,19 +794,6 @@ export interface OrdersResponse {
|
|
|
613
794
|
*/
|
|
614
795
|
'nextPageToken'?: number;
|
|
615
796
|
}
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @export
|
|
619
|
-
* @interface OrdersStatusesResponse
|
|
620
|
-
*/
|
|
621
|
-
export interface OrdersStatusesResponse {
|
|
622
|
-
/**
|
|
623
|
-
*
|
|
624
|
-
* @type {Array<Status>}
|
|
625
|
-
* @memberof OrdersStatusesResponse
|
|
626
|
-
*/
|
|
627
|
-
'statuses'?: Array<Status>;
|
|
628
|
-
}
|
|
629
797
|
/**
|
|
630
798
|
*
|
|
631
799
|
* @export
|
|
@@ -881,16 +1049,16 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
881
1049
|
* 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.
|
|
882
1050
|
* @summary Create order
|
|
883
1051
|
* @param {string} project What project it is
|
|
884
|
-
* @param {
|
|
1052
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
885
1053
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
886
1054
|
* @param {*} [options] Override http request option.
|
|
887
1055
|
* @throws {RequiredError}
|
|
888
1056
|
*/
|
|
889
|
-
createOrder: async (project: string,
|
|
1057
|
+
createOrder: async (project: string, createOrder: CreateOrder, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
890
1058
|
// verify required parameter 'project' is not null or undefined
|
|
891
1059
|
assertParamExists('createOrder', 'project', project)
|
|
892
|
-
// verify required parameter '
|
|
893
|
-
assertParamExists('createOrder', '
|
|
1060
|
+
// verify required parameter 'createOrder' is not null or undefined
|
|
1061
|
+
assertParamExists('createOrder', 'createOrder', createOrder)
|
|
894
1062
|
const localVarPath = `/v1/orders`;
|
|
895
1063
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
896
1064
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -925,7 +1093,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
925
1093
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
926
1094
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
927
1095
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
928
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
1096
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration)
|
|
929
1097
|
|
|
930
1098
|
return {
|
|
931
1099
|
url: toPathString(localVarUrlObj),
|
|
@@ -937,7 +1105,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
937
1105
|
* @summary Export orders
|
|
938
1106
|
* @param {string} project What project it is
|
|
939
1107
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
940
|
-
* @param {string} [end] End of date range
|
|
1108
|
+
* @param {string} [end] End of date range
|
|
941
1109
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
942
1110
|
* @param {*} [options] Override http request option.
|
|
943
1111
|
* @throws {RequiredError}
|
|
@@ -1060,12 +1228,13 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1060
1228
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1061
1229
|
* @param {Array<string>} [ids] Specify fulfillment IDs to list
|
|
1062
1230
|
* @param {Array<Status>} [statuses] Filter by fulfillment status
|
|
1063
|
-
* @param {string} [start] Start of date range
|
|
1064
|
-
* @param {string} [end] End of date range
|
|
1231
|
+
* @param {string} [start] Start of date range
|
|
1232
|
+
* @param {string} [end] End of date range
|
|
1233
|
+
* @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1065
1234
|
* @param {*} [options] Override http request option.
|
|
1066
1235
|
* @throws {RequiredError}
|
|
1067
1236
|
*/
|
|
1068
|
-
getOrders: async (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1237
|
+
getOrders: async (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> => {
|
|
1069
1238
|
// verify required parameter 'project' is not null or undefined
|
|
1070
1239
|
assertParamExists('getOrders', 'project', project)
|
|
1071
1240
|
const localVarPath = `/v1/orders`;
|
|
@@ -1127,48 +1296,8 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1127
1296
|
end;
|
|
1128
1297
|
}
|
|
1129
1298
|
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1133
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1134
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1135
|
-
|
|
1136
|
-
return {
|
|
1137
|
-
url: toPathString(localVarUrlObj),
|
|
1138
|
-
options: localVarRequestOptions,
|
|
1139
|
-
};
|
|
1140
|
-
},
|
|
1141
|
-
/**
|
|
1142
|
-
* Lists orders\' statuses and only include \'quote\' if at least one order has that status
|
|
1143
|
-
* @summary List orders\' statuses
|
|
1144
|
-
* @param {string} project What project it is
|
|
1145
|
-
* @param {*} [options] Override http request option.
|
|
1146
|
-
* @throws {RequiredError}
|
|
1147
|
-
*/
|
|
1148
|
-
getStatuses: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1149
|
-
// verify required parameter 'project' is not null or undefined
|
|
1150
|
-
assertParamExists('getStatuses', 'project', project)
|
|
1151
|
-
const localVarPath = `/v1/orders/statuses`;
|
|
1152
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1153
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1154
|
-
let baseOptions;
|
|
1155
|
-
if (configuration) {
|
|
1156
|
-
baseOptions = configuration.baseOptions;
|
|
1157
|
-
}
|
|
1158
|
-
|
|
1159
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1160
|
-
const localVarHeaderParameter = {} as any;
|
|
1161
|
-
const localVarQueryParameter = {} as any;
|
|
1162
|
-
|
|
1163
|
-
// authentication session-oauth required
|
|
1164
|
-
// oauth required
|
|
1165
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1166
|
-
|
|
1167
|
-
// authentication api-key required
|
|
1168
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1169
|
-
|
|
1170
|
-
if (project !== undefined) {
|
|
1171
|
-
localVarQueryParameter['project'] = project;
|
|
1299
|
+
if (dateFilterType !== undefined) {
|
|
1300
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1172
1301
|
}
|
|
1173
1302
|
|
|
1174
1303
|
|
|
@@ -1227,13 +1356,13 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1227
1356
|
* 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.
|
|
1228
1357
|
* @summary Create order
|
|
1229
1358
|
* @param {string} project What project it is
|
|
1230
|
-
* @param {
|
|
1359
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
1231
1360
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1232
1361
|
* @param {*} [options] Override http request option.
|
|
1233
1362
|
* @throws {RequiredError}
|
|
1234
1363
|
*/
|
|
1235
|
-
async createOrder(project: string,
|
|
1236
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(project,
|
|
1364
|
+
async createOrder(project: string, createOrder: CreateOrder, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
1365
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(project, createOrder, fields, options);
|
|
1237
1366
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1238
1367
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
|
|
1239
1368
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1243,7 +1372,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1243
1372
|
* @summary Export orders
|
|
1244
1373
|
* @param {string} project What project it is
|
|
1245
1374
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1246
|
-
* @param {string} [end] End of date range
|
|
1375
|
+
* @param {string} [end] End of date range
|
|
1247
1376
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1248
1377
|
* @param {*} [options] Override http request option.
|
|
1249
1378
|
* @throws {RequiredError}
|
|
@@ -1279,30 +1408,18 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1279
1408
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1280
1409
|
* @param {Array<string>} [ids] Specify fulfillment IDs to list
|
|
1281
1410
|
* @param {Array<Status>} [statuses] Filter by fulfillment status
|
|
1282
|
-
* @param {string} [start] Start of date range
|
|
1283
|
-
* @param {string} [end] End of date range
|
|
1411
|
+
* @param {string} [start] Start of date range
|
|
1412
|
+
* @param {string} [end] End of date range
|
|
1413
|
+
* @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1284
1414
|
* @param {*} [options] Override http request option.
|
|
1285
1415
|
* @throws {RequiredError}
|
|
1286
1416
|
*/
|
|
1287
|
-
async 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>> {
|
|
1288
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(project, fields, pageToken, pageSize, search, ids, statuses, start, end, options);
|
|
1417
|
+
async 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>> {
|
|
1418
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(project, fields, pageToken, pageSize, search, ids, statuses, start, end, dateFilterType, options);
|
|
1289
1419
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1290
1420
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
1291
1421
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1292
1422
|
},
|
|
1293
|
-
/**
|
|
1294
|
-
* Lists orders\' statuses and only include \'quote\' if at least one order has that status
|
|
1295
|
-
* @summary List orders\' statuses
|
|
1296
|
-
* @param {string} project What project it is
|
|
1297
|
-
* @param {*} [options] Override http request option.
|
|
1298
|
-
* @throws {RequiredError}
|
|
1299
|
-
*/
|
|
1300
|
-
async getStatuses(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersStatusesResponse>> {
|
|
1301
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStatuses(project, options);
|
|
1302
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1303
|
-
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getStatuses']?.[localVarOperationServerIndex]?.url;
|
|
1304
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1305
|
-
},
|
|
1306
1423
|
}
|
|
1307
1424
|
};
|
|
1308
1425
|
|
|
@@ -1341,7 +1458,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
1341
1458
|
* @throws {RequiredError}
|
|
1342
1459
|
*/
|
|
1343
1460
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
1344
|
-
return localVarFp.createOrder(requestParameters.project, requestParameters.
|
|
1461
|
+
return localVarFp.createOrder(requestParameters.project, requestParameters.createOrder, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1345
1462
|
},
|
|
1346
1463
|
/**
|
|
1347
1464
|
* Export orders as a CSV file
|
|
@@ -1371,17 +1488,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
1371
1488
|
* @throws {RequiredError}
|
|
1372
1489
|
*/
|
|
1373
1490
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
1374
|
-
return localVarFp.getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1375
|
-
},
|
|
1376
|
-
/**
|
|
1377
|
-
* Lists orders\' statuses and only include \'quote\' if at least one order has that status
|
|
1378
|
-
* @summary List orders\' statuses
|
|
1379
|
-
* @param {OrdersApiGetStatusesRequest} requestParameters Request parameters.
|
|
1380
|
-
* @param {*} [options] Override http request option.
|
|
1381
|
-
* @throws {RequiredError}
|
|
1382
|
-
*/
|
|
1383
|
-
getStatuses(requestParameters: OrdersApiGetStatusesRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersStatusesResponse> {
|
|
1384
|
-
return localVarFp.getStatuses(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1491
|
+
return localVarFp.getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
1385
1492
|
},
|
|
1386
1493
|
};
|
|
1387
1494
|
};
|
|
@@ -1463,11 +1570,11 @@ export interface OrdersApiCreateOrderRequest {
|
|
|
1463
1570
|
readonly project: string
|
|
1464
1571
|
|
|
1465
1572
|
/**
|
|
1466
|
-
* Order schema
|
|
1467
|
-
* @type {
|
|
1573
|
+
* Create Order schema
|
|
1574
|
+
* @type {CreateOrder}
|
|
1468
1575
|
* @memberof OrdersApiCreateOrder
|
|
1469
1576
|
*/
|
|
1470
|
-
readonly
|
|
1577
|
+
readonly createOrder: CreateOrder
|
|
1471
1578
|
|
|
1472
1579
|
/**
|
|
1473
1580
|
* Specifies which fields to return, separated by commas
|
|
@@ -1498,7 +1605,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
1498
1605
|
readonly start: string
|
|
1499
1606
|
|
|
1500
1607
|
/**
|
|
1501
|
-
* End of date range
|
|
1608
|
+
* End of date range
|
|
1502
1609
|
* @type {string}
|
|
1503
1610
|
* @memberof OrdersApiExportOrders
|
|
1504
1611
|
*/
|
|
@@ -1596,32 +1703,25 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1596
1703
|
readonly statuses?: Array<Status>
|
|
1597
1704
|
|
|
1598
1705
|
/**
|
|
1599
|
-
* Start of date range
|
|
1706
|
+
* Start of date range
|
|
1600
1707
|
* @type {string}
|
|
1601
1708
|
* @memberof OrdersApiGetOrders
|
|
1602
1709
|
*/
|
|
1603
1710
|
readonly start?: string
|
|
1604
1711
|
|
|
1605
1712
|
/**
|
|
1606
|
-
* End of date range
|
|
1713
|
+
* End of date range
|
|
1607
1714
|
* @type {string}
|
|
1608
1715
|
* @memberof OrdersApiGetOrders
|
|
1609
1716
|
*/
|
|
1610
1717
|
readonly end?: string
|
|
1611
|
-
}
|
|
1612
1718
|
|
|
1613
|
-
/**
|
|
1614
|
-
* Request parameters for getStatuses operation in OrdersApi.
|
|
1615
|
-
* @export
|
|
1616
|
-
* @interface OrdersApiGetStatusesRequest
|
|
1617
|
-
*/
|
|
1618
|
-
export interface OrdersApiGetStatusesRequest {
|
|
1619
1719
|
/**
|
|
1620
|
-
*
|
|
1621
|
-
* @type {
|
|
1622
|
-
* @memberof
|
|
1720
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1721
|
+
* @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
|
|
1722
|
+
* @memberof OrdersApiGetOrders
|
|
1623
1723
|
*/
|
|
1624
|
-
readonly
|
|
1724
|
+
readonly dateFilterType?: GetOrdersDateFilterTypeEnum
|
|
1625
1725
|
}
|
|
1626
1726
|
|
|
1627
1727
|
/**
|
|
@@ -1664,7 +1764,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
1664
1764
|
* @memberof OrdersApi
|
|
1665
1765
|
*/
|
|
1666
1766
|
public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
|
|
1667
|
-
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.
|
|
1767
|
+
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.createOrder, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1668
1768
|
}
|
|
1669
1769
|
|
|
1670
1770
|
/**
|
|
@@ -1700,21 +1800,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
1700
1800
|
* @memberof OrdersApi
|
|
1701
1801
|
*/
|
|
1702
1802
|
public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
1703
|
-
return OrdersApiFp(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1704
|
-
}
|
|
1705
|
-
|
|
1706
|
-
/**
|
|
1707
|
-
* Lists orders\' statuses and only include \'quote\' if at least one order has that status
|
|
1708
|
-
* @summary List orders\' statuses
|
|
1709
|
-
* @param {OrdersApiGetStatusesRequest} requestParameters Request parameters.
|
|
1710
|
-
* @param {*} [options] Override http request option.
|
|
1711
|
-
* @throws {RequiredError}
|
|
1712
|
-
* @memberof OrdersApi
|
|
1713
|
-
*/
|
|
1714
|
-
public getStatuses(requestParameters: OrdersApiGetStatusesRequest, options?: RawAxiosRequestConfig) {
|
|
1715
|
-
return OrdersApiFp(this.configuration).getStatuses(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1803
|
+
return OrdersApiFp(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
1716
1804
|
}
|
|
1717
1805
|
}
|
|
1718
1806
|
|
|
1807
|
+
/**
|
|
1808
|
+
* @export
|
|
1809
|
+
*/
|
|
1810
|
+
export const GetOrdersDateFilterTypeEnum = {
|
|
1811
|
+
CreatedAt: 'createdAt',
|
|
1812
|
+
UpdatedAt: 'updatedAt',
|
|
1813
|
+
StatusChangedAt: 'statusChangedAt'
|
|
1814
|
+
} as const;
|
|
1815
|
+
export type GetOrdersDateFilterTypeEnum = typeof GetOrdersDateFilterTypeEnum[keyof typeof GetOrdersDateFilterTypeEnum];
|
|
1719
1816
|
|
|
1720
1817
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
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. For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.13.1
|
|
8
8
|
* Contact: hello@teemill.com
|
|
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 API
|
|
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. For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.13.1
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
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. For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.13.1
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|