@teemill/platform 0.50.0 → 0.51.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 +27 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +19 -4
- package/dist/api.js +17 -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 +19 -4
- package/dist/esm/api.js +15 -6
- 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/DeliveryEstimates.md +1 -0
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +4 -1
- 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.51.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/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.51.1 --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.51.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -389,6 +389,9 @@ export interface DashboardItem {
|
|
|
389
389
|
'sortOrder': number;
|
|
390
390
|
'items'?: Array<DashboardItem> | null;
|
|
391
391
|
}
|
|
392
|
+
/**
|
|
393
|
+
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
394
|
+
*/
|
|
392
395
|
export interface DeliveryEstimates {
|
|
393
396
|
/**
|
|
394
397
|
* ISO 8601 Timestamp
|
|
@@ -612,6 +615,7 @@ export interface Order {
|
|
|
612
615
|
*/
|
|
613
616
|
'merchantReference'?: string | null;
|
|
614
617
|
'fulfillments'?: Array<Fulfillment>;
|
|
618
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
615
619
|
'items': Array<OrderItem>;
|
|
616
620
|
'totalPrice'?: Price;
|
|
617
621
|
'taxPrice'?: Price;
|
|
@@ -986,7 +990,7 @@ export interface ShippingMethod {
|
|
|
986
990
|
'id'?: string;
|
|
987
991
|
'name'?: string;
|
|
988
992
|
'description'?: string;
|
|
989
|
-
'deliveryEstimates'?: DeliveryEstimates;
|
|
993
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
990
994
|
'totalPrice'?: Price;
|
|
991
995
|
'taxPrice'?: Price;
|
|
992
996
|
'subtotalPrice'?: Price;
|
|
@@ -3617,10 +3621,11 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3617
3621
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3618
3622
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
3619
3623
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
3624
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
3620
3625
|
* @param {*} [options] Override http request option.
|
|
3621
3626
|
* @throws {RequiredError}
|
|
3622
3627
|
*/
|
|
3623
|
-
listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3628
|
+
listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3624
3629
|
// verify required parameter 'project' is not null or undefined
|
|
3625
3630
|
assertParamExists('listOrders', 'project', project)
|
|
3626
3631
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -3685,6 +3690,10 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3685
3690
|
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
3686
3691
|
}
|
|
3687
3692
|
|
|
3693
|
+
if (sortBy) {
|
|
3694
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3695
|
+
}
|
|
3696
|
+
|
|
3688
3697
|
|
|
3689
3698
|
|
|
3690
3699
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4140,11 +4149,12 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
4140
4149
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4141
4150
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
4142
4151
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
4152
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
4143
4153
|
* @param {*} [options] Override http request option.
|
|
4144
4154
|
* @throws {RequiredError}
|
|
4145
4155
|
*/
|
|
4146
|
-
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
4147
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
4156
|
+
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
4157
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options);
|
|
4148
4158
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4149
4159
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
4150
4160
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4335,7 +4345,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
4335
4345
|
* @throws {RequiredError}
|
|
4336
4346
|
*/
|
|
4337
4347
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
4338
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
|
|
4348
|
+
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
4339
4349
|
},
|
|
4340
4350
|
/**
|
|
4341
4351
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -4648,6 +4658,11 @@ export interface OrdersApiListOrdersRequest {
|
|
|
4648
4658
|
* The minimum value of the order
|
|
4649
4659
|
*/
|
|
4650
4660
|
readonly minOrderTotal?: number
|
|
4661
|
+
|
|
4662
|
+
/**
|
|
4663
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
4664
|
+
*/
|
|
4665
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>
|
|
4651
4666
|
}
|
|
4652
4667
|
|
|
4653
4668
|
/**
|
|
@@ -4875,7 +4890,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
4875
4890
|
* @throws {RequiredError}
|
|
4876
4891
|
*/
|
|
4877
4892
|
public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4878
|
-
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
|
|
4893
|
+
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
4879
4894
|
}
|
|
4880
4895
|
|
|
4881
4896
|
/**
|
|
@@ -4952,6 +4967,11 @@ export const ListOrdersDateFilterTypeEnum = {
|
|
|
4952
4967
|
RefundedAt: 'refundedAt'
|
|
4953
4968
|
} as const;
|
|
4954
4969
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
4970
|
+
export const ListOrdersSortByEnum = {
|
|
4971
|
+
CreatedAt: '+createdAt',
|
|
4972
|
+
CreatedAt2: '-createdAt'
|
|
4973
|
+
} as const;
|
|
4974
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
4955
4975
|
|
|
4956
4976
|
|
|
4957
4977
|
/**
|
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.51.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -364,6 +364,9 @@ export interface DashboardItem {
|
|
|
364
364
|
'sortOrder': number;
|
|
365
365
|
'items'?: Array<DashboardItem> | null;
|
|
366
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
369
|
+
*/
|
|
367
370
|
export interface DeliveryEstimates {
|
|
368
371
|
/**
|
|
369
372
|
* ISO 8601 Timestamp
|
|
@@ -581,6 +584,7 @@ export interface Order {
|
|
|
581
584
|
*/
|
|
582
585
|
'merchantReference'?: string | null;
|
|
583
586
|
'fulfillments'?: Array<Fulfillment>;
|
|
587
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
584
588
|
'items': Array<OrderItem>;
|
|
585
589
|
'totalPrice'?: Price;
|
|
586
590
|
'taxPrice'?: Price;
|
|
@@ -943,7 +947,7 @@ export interface ShippingMethod {
|
|
|
943
947
|
'id'?: string;
|
|
944
948
|
'name'?: string;
|
|
945
949
|
'description'?: string;
|
|
946
|
-
'deliveryEstimates'?: DeliveryEstimates;
|
|
950
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
947
951
|
'totalPrice'?: Price;
|
|
948
952
|
'taxPrice'?: Price;
|
|
949
953
|
'subtotalPrice'?: Price;
|
|
@@ -2180,10 +2184,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2180
2184
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2181
2185
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2182
2186
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2187
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2183
2188
|
* @param {*} [options] Override http request option.
|
|
2184
2189
|
* @throws {RequiredError}
|
|
2185
2190
|
*/
|
|
2186
|
-
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2191
|
+
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2187
2192
|
/**
|
|
2188
2193
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2189
2194
|
* @summary Retry
|
|
@@ -2351,10 +2356,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2351
2356
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2352
2357
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2353
2358
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2359
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2354
2360
|
* @param {*} [options] Override http request option.
|
|
2355
2361
|
* @throws {RequiredError}
|
|
2356
2362
|
*/
|
|
2357
|
-
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
2363
|
+
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
2358
2364
|
/**
|
|
2359
2365
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2360
2366
|
* @summary Retry
|
|
@@ -2752,6 +2758,10 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2752
2758
|
* The minimum value of the order
|
|
2753
2759
|
*/
|
|
2754
2760
|
readonly minOrderTotal?: number;
|
|
2761
|
+
/**
|
|
2762
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2763
|
+
*/
|
|
2764
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>;
|
|
2755
2765
|
}
|
|
2756
2766
|
/**
|
|
2757
2767
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
@@ -2991,6 +3001,11 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
2991
3001
|
readonly RefundedAt: "refundedAt";
|
|
2992
3002
|
};
|
|
2993
3003
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
3004
|
+
export declare const ListOrdersSortByEnum: {
|
|
3005
|
+
readonly CreatedAt: "+createdAt";
|
|
3006
|
+
readonly CreatedAt2: "-createdAt";
|
|
3007
|
+
};
|
|
3008
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
2994
3009
|
/**
|
|
2995
3010
|
* PaymentApi - axios parameter creator
|
|
2996
3011
|
*/
|
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.51.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,8 +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.
|
|
26
|
-
exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = void 0;
|
|
25
|
+
exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersSortByEnum = exports.ListOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.ModerationApi = exports.ModerationApiFactory = exports.ModerationApiFp = exports.ModerationApiAxiosParamCreator = 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.UpdateModerationItemRequestJudgementEnum = exports.ReturnOrderRequestReturnsInnerActionEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.CreateOrderPaymentMethodTypeEnum = exports.ApplicationPlacementEnum = exports.AmendmentLogAmendmentTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = void 0;
|
|
26
|
+
exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = void 0;
|
|
27
27
|
const axios_1 = require("axios");
|
|
28
28
|
// Some imports not used depending on template conditions
|
|
29
29
|
// @ts-ignore
|
|
@@ -1958,10 +1958,11 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1958
1958
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1959
1959
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
1960
1960
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
1961
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
1961
1962
|
* @param {*} [options] Override http request option.
|
|
1962
1963
|
* @throws {RequiredError}
|
|
1963
1964
|
*/
|
|
1964
|
-
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options = {}) {
|
|
1965
|
+
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, sortBy_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, sortBy_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options = {}) {
|
|
1965
1966
|
// verify required parameter 'project' is not null or undefined
|
|
1966
1967
|
(0, common_1.assertParamExists)('listOrders', 'project', project);
|
|
1967
1968
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -2013,6 +2014,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
2013
2014
|
if (minOrderTotal !== undefined) {
|
|
2014
2015
|
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
2015
2016
|
}
|
|
2017
|
+
if (sortBy) {
|
|
2018
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2019
|
+
}
|
|
2016
2020
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2017
2021
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2018
2022
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2449,13 +2453,14 @@ const OrdersApiFp = function (configuration) {
|
|
|
2449
2453
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2450
2454
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2451
2455
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2456
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2452
2457
|
* @param {*} [options] Override http request option.
|
|
2453
2458
|
* @throws {RequiredError}
|
|
2454
2459
|
*/
|
|
2455
|
-
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options) {
|
|
2460
|
+
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options) {
|
|
2456
2461
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2457
2462
|
var _a, _b, _c;
|
|
2458
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
2463
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options);
|
|
2459
2464
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2460
2465
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.listOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2461
2466
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2662,7 +2667,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2662
2667
|
* @throws {RequiredError}
|
|
2663
2668
|
*/
|
|
2664
2669
|
listOrders(requestParameters, options) {
|
|
2665
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
|
|
2670
|
+
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
2666
2671
|
},
|
|
2667
2672
|
/**
|
|
2668
2673
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -2819,7 +2824,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
2819
2824
|
* @throws {RequiredError}
|
|
2820
2825
|
*/
|
|
2821
2826
|
listOrders(requestParameters, options) {
|
|
2822
|
-
return (0, exports.OrdersApiFp)(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
|
|
2827
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
2823
2828
|
}
|
|
2824
2829
|
/**
|
|
2825
2830
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -2889,6 +2894,10 @@ exports.ListOrdersDateFilterTypeEnum = {
|
|
|
2889
2894
|
CompletedAt: 'completedAt',
|
|
2890
2895
|
RefundedAt: 'refundedAt'
|
|
2891
2896
|
};
|
|
2897
|
+
exports.ListOrdersSortByEnum = {
|
|
2898
|
+
CreatedAt: '+createdAt',
|
|
2899
|
+
CreatedAt2: '-createdAt'
|
|
2900
|
+
};
|
|
2892
2901
|
/**
|
|
2893
2902
|
* PaymentApi - axios parameter creator
|
|
2894
2903
|
*/
|
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.51.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -364,6 +364,9 @@ export interface DashboardItem {
|
|
|
364
364
|
'sortOrder': number;
|
|
365
365
|
'items'?: Array<DashboardItem> | null;
|
|
366
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
369
|
+
*/
|
|
367
370
|
export interface DeliveryEstimates {
|
|
368
371
|
/**
|
|
369
372
|
* ISO 8601 Timestamp
|
|
@@ -581,6 +584,7 @@ export interface Order {
|
|
|
581
584
|
*/
|
|
582
585
|
'merchantReference'?: string | null;
|
|
583
586
|
'fulfillments'?: Array<Fulfillment>;
|
|
587
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
584
588
|
'items': Array<OrderItem>;
|
|
585
589
|
'totalPrice'?: Price;
|
|
586
590
|
'taxPrice'?: Price;
|
|
@@ -943,7 +947,7 @@ export interface ShippingMethod {
|
|
|
943
947
|
'id'?: string;
|
|
944
948
|
'name'?: string;
|
|
945
949
|
'description'?: string;
|
|
946
|
-
'deliveryEstimates'?: DeliveryEstimates;
|
|
950
|
+
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
947
951
|
'totalPrice'?: Price;
|
|
948
952
|
'taxPrice'?: Price;
|
|
949
953
|
'subtotalPrice'?: Price;
|
|
@@ -2180,10 +2184,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2180
2184
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2181
2185
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2182
2186
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2187
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2183
2188
|
* @param {*} [options] Override http request option.
|
|
2184
2189
|
* @throws {RequiredError}
|
|
2185
2190
|
*/
|
|
2186
|
-
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2191
|
+
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2187
2192
|
/**
|
|
2188
2193
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2189
2194
|
* @summary Retry
|
|
@@ -2351,10 +2356,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2351
2356
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2352
2357
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2353
2358
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2359
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2354
2360
|
* @param {*} [options] Override http request option.
|
|
2355
2361
|
* @throws {RequiredError}
|
|
2356
2362
|
*/
|
|
2357
|
-
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
2363
|
+
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, maxOrderTotal?: number, minOrderTotal?: number, sortBy?: Array<ListOrdersSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
2358
2364
|
/**
|
|
2359
2365
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2360
2366
|
* @summary Retry
|
|
@@ -2752,6 +2758,10 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2752
2758
|
* The minimum value of the order
|
|
2753
2759
|
*/
|
|
2754
2760
|
readonly minOrderTotal?: number;
|
|
2761
|
+
/**
|
|
2762
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2763
|
+
*/
|
|
2764
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>;
|
|
2755
2765
|
}
|
|
2756
2766
|
/**
|
|
2757
2767
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
@@ -2991,6 +3001,11 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
2991
3001
|
readonly RefundedAt: "refundedAt";
|
|
2992
3002
|
};
|
|
2993
3003
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
3004
|
+
export declare const ListOrdersSortByEnum: {
|
|
3005
|
+
readonly CreatedAt: "+createdAt";
|
|
3006
|
+
readonly CreatedAt2: "-createdAt";
|
|
3007
|
+
};
|
|
3008
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
2994
3009
|
/**
|
|
2995
3010
|
* PaymentApi - axios parameter creator
|
|
2996
3011
|
*/
|
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.51.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1938,10 +1938,11 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1938
1938
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1939
1939
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
1940
1940
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
1941
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
1941
1942
|
* @param {*} [options] Override http request option.
|
|
1942
1943
|
* @throws {RequiredError}
|
|
1943
1944
|
*/
|
|
1944
|
-
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options = {}) {
|
|
1945
|
+
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, sortBy_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, sortBy_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options = {}) {
|
|
1945
1946
|
// verify required parameter 'project' is not null or undefined
|
|
1946
1947
|
assertParamExists('listOrders', 'project', project);
|
|
1947
1948
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1993,6 +1994,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1993
1994
|
if (minOrderTotal !== undefined) {
|
|
1994
1995
|
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
1995
1996
|
}
|
|
1997
|
+
if (sortBy) {
|
|
1998
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1999
|
+
}
|
|
1996
2000
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1997
2001
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1998
2002
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2428,13 +2432,14 @@ export const OrdersApiFp = function (configuration) {
|
|
|
2428
2432
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2429
2433
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2430
2434
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2435
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2431
2436
|
* @param {*} [options] Override http request option.
|
|
2432
2437
|
* @throws {RequiredError}
|
|
2433
2438
|
*/
|
|
2434
|
-
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options) {
|
|
2439
|
+
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options) {
|
|
2435
2440
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2436
2441
|
var _a, _b, _c;
|
|
2437
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
2442
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options);
|
|
2438
2443
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2439
2444
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.listOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2440
2445
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2640,7 +2645,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2640
2645
|
* @throws {RequiredError}
|
|
2641
2646
|
*/
|
|
2642
2647
|
listOrders(requestParameters, options) {
|
|
2643
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
|
|
2648
|
+
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
2644
2649
|
},
|
|
2645
2650
|
/**
|
|
2646
2651
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -2796,7 +2801,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
2796
2801
|
* @throws {RequiredError}
|
|
2797
2802
|
*/
|
|
2798
2803
|
listOrders(requestParameters, options) {
|
|
2799
|
-
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
|
|
2804
|
+
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
2800
2805
|
}
|
|
2801
2806
|
/**
|
|
2802
2807
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -2865,6 +2870,10 @@ export const ListOrdersDateFilterTypeEnum = {
|
|
|
2865
2870
|
CompletedAt: 'completedAt',
|
|
2866
2871
|
RefundedAt: 'refundedAt'
|
|
2867
2872
|
};
|
|
2873
|
+
export const ListOrdersSortByEnum = {
|
|
2874
|
+
CreatedAt: '+createdAt',
|
|
2875
|
+
CreatedAt2: '-createdAt'
|
|
2876
|
+
};
|
|
2868
2877
|
/**
|
|
2869
2878
|
* PaymentApi - axios parameter creator
|
|
2870
2879
|
*/
|
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/Order.md
CHANGED
|
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
18
18
|
**merchantReference** | **string** | A custom reference to the merchant\'s order that will be displayed on the shipping label. | [optional] [default to undefined]
|
|
19
19
|
**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) | | [optional] [readonly] [default to undefined]
|
|
20
|
+
**deliveryEstimates** | [**DeliveryEstimates**](DeliveryEstimates.md) | | [optional] [default to undefined]
|
|
20
21
|
**items** | [**Array<OrderItem>**](OrderItem.md) | | [default to undefined]
|
|
21
22
|
**totalPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
22
23
|
**taxPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
@@ -50,6 +51,7 @@ const instance: Order = {
|
|
|
50
51
|
updatedAt,
|
|
51
52
|
merchantReference,
|
|
52
53
|
fulfillments,
|
|
54
|
+
deliveryEstimates,
|
|
53
55
|
items,
|
|
54
56
|
totalPrice,
|
|
55
57
|
taxPrice,
|
package/docs/OrdersApi.md
CHANGED
|
@@ -619,6 +619,7 @@ let end: string; //End of date range to filter when orders were placed (optional
|
|
|
619
619
|
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')
|
|
620
620
|
let maxOrderTotal: number; //The maximum value of the order (optional) (default to undefined)
|
|
621
621
|
let minOrderTotal: number; //The minimum value of the order (optional) (default to undefined)
|
|
622
|
+
let sortBy: Array<'+createdAt' | '-createdAt'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending. (optional) (default to undefined)
|
|
622
623
|
|
|
623
624
|
const { status, data } = await apiInstance.listOrders(
|
|
624
625
|
project,
|
|
@@ -630,7 +631,8 @@ const { status, data } = await apiInstance.listOrders(
|
|
|
630
631
|
end,
|
|
631
632
|
dateFilterType,
|
|
632
633
|
maxOrderTotal,
|
|
633
|
-
minOrderTotal
|
|
634
|
+
minOrderTotal,
|
|
635
|
+
sortBy
|
|
634
636
|
);
|
|
635
637
|
```
|
|
636
638
|
|
|
@@ -648,6 +650,7 @@ const { status, data } = await apiInstance.listOrders(
|
|
|
648
650
|
| **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'|
|
|
649
651
|
| **maxOrderTotal** | [**number**] | The maximum value of the order | (optional) defaults to undefined|
|
|
650
652
|
| **minOrderTotal** | [**number**] | The minimum value of the order | (optional) defaults to undefined|
|
|
653
|
+
| **sortBy** | **Array<'+createdAt' | '-createdAt'>** | An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending. | (optional) defaults to undefined|
|
|
651
654
|
|
|
652
655
|
|
|
653
656
|
### Return type
|
package/index.ts
CHANGED