@teemill/platform 0.41.0 → 0.43.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/README.md +2 -2
- package/api.ts +38 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +29 -3
- package/dist/api.js +25 -8
- 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 +29 -3
- package/dist/esm/api.js +23 -7
- 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/docs/CreateOrder.md +2 -0
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +6 -3
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.43.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/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.43.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.43.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -208,6 +208,10 @@ export interface CreateOrder {
|
|
|
208
208
|
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
209
209
|
*/
|
|
210
210
|
'client'?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Determine whether this order will go through the bulk production flow or not
|
|
213
|
+
*/
|
|
214
|
+
'bulk'?: boolean;
|
|
211
215
|
}
|
|
212
216
|
export interface CreateOrderChatChannel200Response {
|
|
213
217
|
/**
|
|
@@ -572,6 +576,10 @@ export interface Order {
|
|
|
572
576
|
* Reference to the chat channel resource
|
|
573
577
|
*/
|
|
574
578
|
'chatChannelRef'?: string | null;
|
|
579
|
+
/**
|
|
580
|
+
* Whether this order will go through the bulk production flow or not
|
|
581
|
+
*/
|
|
582
|
+
'bulk'?: boolean;
|
|
575
583
|
}
|
|
576
584
|
|
|
577
585
|
|
|
@@ -2987,10 +2995,11 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2987
2995
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2988
2996
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2989
2997
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2998
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2990
2999
|
* @param {*} [options] Override http request option.
|
|
2991
3000
|
* @throws {RequiredError}
|
|
2992
3001
|
*/
|
|
2993
|
-
exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3002
|
+
exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2994
3003
|
// verify required parameter 'project' is not null or undefined
|
|
2995
3004
|
assertParamExists('exportOrders', 'project', project)
|
|
2996
3005
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -3037,6 +3046,10 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3037
3046
|
localVarQueryParameter['search'] = search;
|
|
3038
3047
|
}
|
|
3039
3048
|
|
|
3049
|
+
if (dateFilterType !== undefined) {
|
|
3050
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
3051
|
+
}
|
|
3052
|
+
|
|
3040
3053
|
|
|
3041
3054
|
|
|
3042
3055
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3647,11 +3660,12 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3647
3660
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
3648
3661
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
3649
3662
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3663
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3650
3664
|
* @param {*} [options] Override http request option.
|
|
3651
3665
|
* @throws {RequiredError}
|
|
3652
3666
|
*/
|
|
3653
|
-
async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3654
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
3667
|
+
async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3668
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
|
|
3655
3669
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3656
3670
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
3657
3671
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3857,7 +3871,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3857
3871
|
* @throws {RequiredError}
|
|
3858
3872
|
*/
|
|
3859
3873
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3860
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3874
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
3861
3875
|
},
|
|
3862
3876
|
/**
|
|
3863
3877
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -4070,6 +4084,11 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
4070
4084
|
* Search term to filter based on order reference, customer name and email
|
|
4071
4085
|
*/
|
|
4072
4086
|
readonly search?: string
|
|
4087
|
+
|
|
4088
|
+
/**
|
|
4089
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4090
|
+
*/
|
|
4091
|
+
readonly dateFilterType?: ExportOrdersDateFilterTypeEnum
|
|
4073
4092
|
}
|
|
4074
4093
|
|
|
4075
4094
|
/**
|
|
@@ -4350,7 +4369,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
4350
4369
|
* @throws {RequiredError}
|
|
4351
4370
|
*/
|
|
4352
4371
|
public exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4353
|
-
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
4372
|
+
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
4354
4373
|
}
|
|
4355
4374
|
|
|
4356
4375
|
/**
|
|
@@ -4453,10 +4472,22 @@ export class OrdersApi extends BaseAPI {
|
|
|
4453
4472
|
}
|
|
4454
4473
|
}
|
|
4455
4474
|
|
|
4475
|
+
export const ExportOrdersDateFilterTypeEnum = {
|
|
4476
|
+
CreatedAt: 'createdAt',
|
|
4477
|
+
PaidAt: 'paidAt',
|
|
4478
|
+
UpdatedAt: 'updatedAt',
|
|
4479
|
+
StatusChangedAt: 'statusChangedAt',
|
|
4480
|
+
CompletedAt: 'completedAt',
|
|
4481
|
+
RefundedAt: 'refundedAt'
|
|
4482
|
+
} as const;
|
|
4483
|
+
export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
|
|
4456
4484
|
export const ListOrdersDateFilterTypeEnum = {
|
|
4457
4485
|
CreatedAt: 'createdAt',
|
|
4486
|
+
PaidAt: 'paidAt',
|
|
4458
4487
|
UpdatedAt: 'updatedAt',
|
|
4459
|
-
StatusChangedAt: 'statusChangedAt'
|
|
4488
|
+
StatusChangedAt: 'statusChangedAt',
|
|
4489
|
+
CompletedAt: 'completedAt',
|
|
4490
|
+
RefundedAt: 'refundedAt'
|
|
4460
4491
|
} as const;
|
|
4461
4492
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
4462
4493
|
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.43.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -192,6 +192,10 @@ export interface CreateOrder {
|
|
|
192
192
|
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
193
193
|
*/
|
|
194
194
|
'client'?: string;
|
|
195
|
+
/**
|
|
196
|
+
* Determine whether this order will go through the bulk production flow or not
|
|
197
|
+
*/
|
|
198
|
+
'bulk'?: boolean;
|
|
195
199
|
}
|
|
196
200
|
export interface CreateOrderChatChannel200Response {
|
|
197
201
|
/**
|
|
@@ -547,6 +551,10 @@ export interface Order {
|
|
|
547
551
|
* Reference to the chat channel resource
|
|
548
552
|
*/
|
|
549
553
|
'chatChannelRef'?: string | null;
|
|
554
|
+
/**
|
|
555
|
+
* Whether this order will go through the bulk production flow or not
|
|
556
|
+
*/
|
|
557
|
+
'bulk'?: boolean;
|
|
550
558
|
}
|
|
551
559
|
export interface OrderItem {
|
|
552
560
|
/**
|
|
@@ -1911,10 +1919,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1911
1919
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1912
1920
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1913
1921
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1922
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1914
1923
|
* @param {*} [options] Override http request option.
|
|
1915
1924
|
* @throws {RequiredError}
|
|
1916
1925
|
*/
|
|
1917
|
-
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1926
|
+
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1918
1927
|
/**
|
|
1919
1928
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1920
1929
|
* @summary Get fulfillment
|
|
@@ -2069,10 +2078,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2069
2078
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2070
2079
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2071
2080
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2081
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2072
2082
|
* @param {*} [options] Override http request option.
|
|
2073
2083
|
* @throws {RequiredError}
|
|
2074
2084
|
*/
|
|
2075
|
-
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2085
|
+
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2076
2086
|
/**
|
|
2077
2087
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2078
2088
|
* @summary Get fulfillment
|
|
@@ -2390,6 +2400,10 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2390
2400
|
* Search term to filter based on order reference, customer name and email
|
|
2391
2401
|
*/
|
|
2392
2402
|
readonly search?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2405
|
+
*/
|
|
2406
|
+
readonly dateFilterType?: ExportOrdersDateFilterTypeEnum;
|
|
2393
2407
|
}
|
|
2394
2408
|
/**
|
|
2395
2409
|
* Request parameters for getFulfillment operation in OrdersApi.
|
|
@@ -2694,10 +2708,22 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2694
2708
|
*/
|
|
2695
2709
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any, {}>>;
|
|
2696
2710
|
}
|
|
2711
|
+
export declare const ExportOrdersDateFilterTypeEnum: {
|
|
2712
|
+
readonly CreatedAt: "createdAt";
|
|
2713
|
+
readonly PaidAt: "paidAt";
|
|
2714
|
+
readonly UpdatedAt: "updatedAt";
|
|
2715
|
+
readonly StatusChangedAt: "statusChangedAt";
|
|
2716
|
+
readonly CompletedAt: "completedAt";
|
|
2717
|
+
readonly RefundedAt: "refundedAt";
|
|
2718
|
+
};
|
|
2719
|
+
export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
|
|
2697
2720
|
export declare const ListOrdersDateFilterTypeEnum: {
|
|
2698
2721
|
readonly CreatedAt: "createdAt";
|
|
2722
|
+
readonly PaidAt: "paidAt";
|
|
2699
2723
|
readonly UpdatedAt: "updatedAt";
|
|
2700
2724
|
readonly StatusChangedAt: "statusChangedAt";
|
|
2725
|
+
readonly CompletedAt: "completedAt";
|
|
2726
|
+
readonly RefundedAt: "refundedAt";
|
|
2701
2727
|
};
|
|
2702
2728
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
2703
2729
|
/**
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.43.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.DashboardApi = exports.DashboardApiFactory = exports.DashboardApiFp = exports.DashboardApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.ReturnOrderRequestReturnsInnerActionEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.AmendmentLogAmendmentTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = void 0;
|
|
26
|
+
exports.TermsApi = void 0;
|
|
26
27
|
const axios_1 = require("axios");
|
|
27
28
|
// Some imports not used depending on template conditions
|
|
28
29
|
// @ts-ignore
|
|
@@ -1505,10 +1506,11 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1505
1506
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1506
1507
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1507
1508
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1509
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1508
1510
|
* @param {*} [options] Override http request option.
|
|
1509
1511
|
* @throws {RequiredError}
|
|
1510
1512
|
*/
|
|
1511
|
-
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, ...args_1], void 0, function* (project, platformId, start, end, search, options = {}) {
|
|
1513
|
+
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1], void 0, function* (project, platformId, start, end, search, dateFilterType, options = {}) {
|
|
1512
1514
|
// verify required parameter 'project' is not null or undefined
|
|
1513
1515
|
(0, common_1.assertParamExists)('exportOrders', 'project', project);
|
|
1514
1516
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1547,6 +1549,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1547
1549
|
if (search !== undefined) {
|
|
1548
1550
|
localVarQueryParameter['search'] = search;
|
|
1549
1551
|
}
|
|
1552
|
+
if (dateFilterType !== undefined) {
|
|
1553
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1554
|
+
}
|
|
1550
1555
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1551
1556
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1552
1557
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2084,13 +2089,14 @@ const OrdersApiFp = function (configuration) {
|
|
|
2084
2089
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2085
2090
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2086
2091
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2092
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2087
2093
|
* @param {*} [options] Override http request option.
|
|
2088
2094
|
* @throws {RequiredError}
|
|
2089
2095
|
*/
|
|
2090
|
-
exportOrders(project, platformId, start, end, search, options) {
|
|
2096
|
+
exportOrders(project, platformId, start, end, search, dateFilterType, options) {
|
|
2091
2097
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2092
2098
|
var _a, _b, _c;
|
|
2093
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
2099
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
|
|
2094
2100
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2095
2101
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.exportOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2096
2102
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2324,7 +2330,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2324
2330
|
* @throws {RequiredError}
|
|
2325
2331
|
*/
|
|
2326
2332
|
exportOrders(requestParameters, options) {
|
|
2327
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2333
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
2328
2334
|
},
|
|
2329
2335
|
/**
|
|
2330
2336
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2471,7 +2477,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
2471
2477
|
* @throws {RequiredError}
|
|
2472
2478
|
*/
|
|
2473
2479
|
exportOrders(requestParameters, options) {
|
|
2474
|
-
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2480
|
+
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
2475
2481
|
}
|
|
2476
2482
|
/**
|
|
2477
2483
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2565,10 +2571,21 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
2565
2571
|
}
|
|
2566
2572
|
}
|
|
2567
2573
|
exports.OrdersApi = OrdersApi;
|
|
2574
|
+
exports.ExportOrdersDateFilterTypeEnum = {
|
|
2575
|
+
CreatedAt: 'createdAt',
|
|
2576
|
+
PaidAt: 'paidAt',
|
|
2577
|
+
UpdatedAt: 'updatedAt',
|
|
2578
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2579
|
+
CompletedAt: 'completedAt',
|
|
2580
|
+
RefundedAt: 'refundedAt'
|
|
2581
|
+
};
|
|
2568
2582
|
exports.ListOrdersDateFilterTypeEnum = {
|
|
2569
2583
|
CreatedAt: 'createdAt',
|
|
2584
|
+
PaidAt: 'paidAt',
|
|
2570
2585
|
UpdatedAt: 'updatedAt',
|
|
2571
|
-
StatusChangedAt: 'statusChangedAt'
|
|
2586
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2587
|
+
CompletedAt: 'completedAt',
|
|
2588
|
+
RefundedAt: 'refundedAt'
|
|
2572
2589
|
};
|
|
2573
2590
|
/**
|
|
2574
2591
|
* PaymentApi - axios parameter creator
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.43.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -192,6 +192,10 @@ export interface CreateOrder {
|
|
|
192
192
|
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
193
193
|
*/
|
|
194
194
|
'client'?: string;
|
|
195
|
+
/**
|
|
196
|
+
* Determine whether this order will go through the bulk production flow or not
|
|
197
|
+
*/
|
|
198
|
+
'bulk'?: boolean;
|
|
195
199
|
}
|
|
196
200
|
export interface CreateOrderChatChannel200Response {
|
|
197
201
|
/**
|
|
@@ -547,6 +551,10 @@ export interface Order {
|
|
|
547
551
|
* Reference to the chat channel resource
|
|
548
552
|
*/
|
|
549
553
|
'chatChannelRef'?: string | null;
|
|
554
|
+
/**
|
|
555
|
+
* Whether this order will go through the bulk production flow or not
|
|
556
|
+
*/
|
|
557
|
+
'bulk'?: boolean;
|
|
550
558
|
}
|
|
551
559
|
export interface OrderItem {
|
|
552
560
|
/**
|
|
@@ -1911,10 +1919,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1911
1919
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1912
1920
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1913
1921
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1922
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1914
1923
|
* @param {*} [options] Override http request option.
|
|
1915
1924
|
* @throws {RequiredError}
|
|
1916
1925
|
*/
|
|
1917
|
-
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1926
|
+
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1918
1927
|
/**
|
|
1919
1928
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1920
1929
|
* @summary Get fulfillment
|
|
@@ -2069,10 +2078,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2069
2078
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2070
2079
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2071
2080
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2081
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2072
2082
|
* @param {*} [options] Override http request option.
|
|
2073
2083
|
* @throws {RequiredError}
|
|
2074
2084
|
*/
|
|
2075
|
-
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2085
|
+
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2076
2086
|
/**
|
|
2077
2087
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2078
2088
|
* @summary Get fulfillment
|
|
@@ -2390,6 +2400,10 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2390
2400
|
* Search term to filter based on order reference, customer name and email
|
|
2391
2401
|
*/
|
|
2392
2402
|
readonly search?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2405
|
+
*/
|
|
2406
|
+
readonly dateFilterType?: ExportOrdersDateFilterTypeEnum;
|
|
2393
2407
|
}
|
|
2394
2408
|
/**
|
|
2395
2409
|
* Request parameters for getFulfillment operation in OrdersApi.
|
|
@@ -2694,10 +2708,22 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2694
2708
|
*/
|
|
2695
2709
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any, {}>>;
|
|
2696
2710
|
}
|
|
2711
|
+
export declare const ExportOrdersDateFilterTypeEnum: {
|
|
2712
|
+
readonly CreatedAt: "createdAt";
|
|
2713
|
+
readonly PaidAt: "paidAt";
|
|
2714
|
+
readonly UpdatedAt: "updatedAt";
|
|
2715
|
+
readonly StatusChangedAt: "statusChangedAt";
|
|
2716
|
+
readonly CompletedAt: "completedAt";
|
|
2717
|
+
readonly RefundedAt: "refundedAt";
|
|
2718
|
+
};
|
|
2719
|
+
export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
|
|
2697
2720
|
export declare const ListOrdersDateFilterTypeEnum: {
|
|
2698
2721
|
readonly CreatedAt: "createdAt";
|
|
2722
|
+
readonly PaidAt: "paidAt";
|
|
2699
2723
|
readonly UpdatedAt: "updatedAt";
|
|
2700
2724
|
readonly StatusChangedAt: "statusChangedAt";
|
|
2725
|
+
readonly CompletedAt: "completedAt";
|
|
2726
|
+
readonly RefundedAt: "refundedAt";
|
|
2701
2727
|
};
|
|
2702
2728
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
2703
2729
|
/**
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.43.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1490,10 +1490,11 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1490
1490
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1491
1491
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1492
1492
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1493
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1493
1494
|
* @param {*} [options] Override http request option.
|
|
1494
1495
|
* @throws {RequiredError}
|
|
1495
1496
|
*/
|
|
1496
|
-
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, ...args_1], void 0, function* (project, platformId, start, end, search, options = {}) {
|
|
1497
|
+
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1], void 0, function* (project, platformId, start, end, search, dateFilterType, options = {}) {
|
|
1497
1498
|
// verify required parameter 'project' is not null or undefined
|
|
1498
1499
|
assertParamExists('exportOrders', 'project', project);
|
|
1499
1500
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1532,6 +1533,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1532
1533
|
if (search !== undefined) {
|
|
1533
1534
|
localVarQueryParameter['search'] = search;
|
|
1534
1535
|
}
|
|
1536
|
+
if (dateFilterType !== undefined) {
|
|
1537
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1538
|
+
}
|
|
1535
1539
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1536
1540
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1537
1541
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2068,13 +2072,14 @@ export const OrdersApiFp = function (configuration) {
|
|
|
2068
2072
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2069
2073
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2070
2074
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2075
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2071
2076
|
* @param {*} [options] Override http request option.
|
|
2072
2077
|
* @throws {RequiredError}
|
|
2073
2078
|
*/
|
|
2074
|
-
exportOrders(project, platformId, start, end, search, options) {
|
|
2079
|
+
exportOrders(project, platformId, start, end, search, dateFilterType, options) {
|
|
2075
2080
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2076
2081
|
var _a, _b, _c;
|
|
2077
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
2082
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
|
|
2078
2083
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2079
2084
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.exportOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2080
2085
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2307,7 +2312,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2307
2312
|
* @throws {RequiredError}
|
|
2308
2313
|
*/
|
|
2309
2314
|
exportOrders(requestParameters, options) {
|
|
2310
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2315
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
2311
2316
|
},
|
|
2312
2317
|
/**
|
|
2313
2318
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2453,7 +2458,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
2453
2458
|
* @throws {RequiredError}
|
|
2454
2459
|
*/
|
|
2455
2460
|
exportOrders(requestParameters, options) {
|
|
2456
|
-
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2461
|
+
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
2457
2462
|
}
|
|
2458
2463
|
/**
|
|
2459
2464
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2546,10 +2551,21 @@ export class OrdersApi extends BaseAPI {
|
|
|
2546
2551
|
return OrdersApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2547
2552
|
}
|
|
2548
2553
|
}
|
|
2554
|
+
export const ExportOrdersDateFilterTypeEnum = {
|
|
2555
|
+
CreatedAt: 'createdAt',
|
|
2556
|
+
PaidAt: 'paidAt',
|
|
2557
|
+
UpdatedAt: 'updatedAt',
|
|
2558
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2559
|
+
CompletedAt: 'completedAt',
|
|
2560
|
+
RefundedAt: 'refundedAt'
|
|
2561
|
+
};
|
|
2549
2562
|
export const ListOrdersDateFilterTypeEnum = {
|
|
2550
2563
|
CreatedAt: 'createdAt',
|
|
2564
|
+
PaidAt: 'paidAt',
|
|
2551
2565
|
UpdatedAt: 'updatedAt',
|
|
2552
|
-
StatusChangedAt: 'statusChangedAt'
|
|
2566
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2567
|
+
CompletedAt: 'completedAt',
|
|
2568
|
+
RefundedAt: 'refundedAt'
|
|
2553
2569
|
};
|
|
2554
2570
|
/**
|
|
2555
2571
|
* PaymentApi - axios parameter creator
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/CreateOrder.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**preferredFulfillers** | **Array<string>** | | [optional] [default to undefined]
|
|
16
16
|
**originalOrderRef** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
17
17
|
**client** | **string** | The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project. | [optional] [default to undefined]
|
|
18
|
+
**bulk** | **boolean** | Determine whether this order will go through the bulk production flow or not | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -31,6 +32,7 @@ const instance: CreateOrder = {
|
|
|
31
32
|
preferredFulfillers,
|
|
32
33
|
originalOrderRef,
|
|
33
34
|
client,
|
|
35
|
+
bulk,
|
|
34
36
|
};
|
|
35
37
|
```
|
|
36
38
|
|
package/docs/Order.md
CHANGED
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) | | [optional] [default to undefined]
|
|
29
29
|
**integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
|
|
30
30
|
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
31
|
+
**bulk** | **boolean** | Whether this order will go through the bulk production flow or not | [optional] [default to undefined]
|
|
31
32
|
|
|
32
33
|
## Example
|
|
33
34
|
|
|
@@ -58,6 +59,7 @@ const instance: Order = {
|
|
|
58
59
|
paymentAttempts,
|
|
59
60
|
integrationType,
|
|
60
61
|
chatChannelRef,
|
|
62
|
+
bulk,
|
|
61
63
|
};
|
|
62
64
|
```
|
|
63
65
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -293,13 +293,15 @@ let platformId: string; //The platform identifier (default to undefined)
|
|
|
293
293
|
let start: string; //Start of date range to filter by when orders were placed (default to undefined)
|
|
294
294
|
let end: string; //End of date range to filter when orders were placed (optional) (default to undefined)
|
|
295
295
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
296
|
+
let dateFilterType: 'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
296
297
|
|
|
297
298
|
const { status, data } = await apiInstance.exportOrders(
|
|
298
299
|
project,
|
|
299
300
|
platformId,
|
|
300
301
|
start,
|
|
301
302
|
end,
|
|
302
|
-
search
|
|
303
|
+
search,
|
|
304
|
+
dateFilterType
|
|
303
305
|
);
|
|
304
306
|
```
|
|
305
307
|
|
|
@@ -312,6 +314,7 @@ const { status, data } = await apiInstance.exportOrders(
|
|
|
312
314
|
| **start** | [**string**] | Start of date range to filter by when orders were placed | defaults to undefined|
|
|
313
315
|
| **end** | [**string**] | End of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
314
316
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
317
|
+
| **dateFilterType** | [**'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'**]**Array<'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
315
318
|
|
|
316
319
|
|
|
317
320
|
### Return type
|
|
@@ -611,7 +614,7 @@ let pageSize: number; //Max page size. This is the maximum page size that will b
|
|
|
611
614
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
612
615
|
let start: string; //Start of date range to filter when orders were placed (optional) (default to undefined)
|
|
613
616
|
let end: string; //End of date range to filter when orders were placed (optional) (default to undefined)
|
|
614
|
-
let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
617
|
+
let dateFilterType: 'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
615
618
|
let maxOrderTotal: number; //The maximum value of the order (optional) (default to undefined)
|
|
616
619
|
let minOrderTotal: number; //The minimum value of the order (optional) (default to undefined)
|
|
617
620
|
|
|
@@ -640,7 +643,7 @@ const { status, data } = await apiInstance.listOrders(
|
|
|
640
643
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
641
644
|
| **start** | [**string**] | Start of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
642
645
|
| **end** | [**string**] | End of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
643
|
-
| **dateFilterType** | [**'createdAt' | 'updatedAt' | 'statusChangedAt'**]**Array<'createdAt' | 'updatedAt' | 'statusChangedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
646
|
+
| **dateFilterType** | [**'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'**]**Array<'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
644
647
|
| **maxOrderTotal** | [**number**] | The maximum value of the order | (optional) defaults to undefined|
|
|
645
648
|
| **minOrderTotal** | [**number**] | The minimum value of the order | (optional) defaults to undefined|
|
|
646
649
|
|
package/index.ts
CHANGED