@teemill/platform 0.51.0 → 0.52.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 +27 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +19 -3
- 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 -3
- 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/Fulfillment.md +2 -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.52.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.52.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.52.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -510,6 +510,10 @@ export interface Fulfillment {
|
|
|
510
510
|
* Weight of the package being shipped in grams
|
|
511
511
|
*/
|
|
512
512
|
'packageWeight'?: number;
|
|
513
|
+
/**
|
|
514
|
+
* A reference to the resource location
|
|
515
|
+
*/
|
|
516
|
+
'platformRef'?: string;
|
|
513
517
|
}
|
|
514
518
|
|
|
515
519
|
|
|
@@ -598,6 +602,7 @@ export interface Order {
|
|
|
598
602
|
'ref'?: string;
|
|
599
603
|
'status'?: OrderStatus;
|
|
600
604
|
'approvalItemId'?: string | null;
|
|
605
|
+
'customerRef': string;
|
|
601
606
|
'contactInformation': ContactInformation;
|
|
602
607
|
'paymentMethod'?: OrderPaymentMethod;
|
|
603
608
|
'shippingAddress': Address;
|
|
@@ -3621,10 +3626,11 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3621
3626
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3622
3627
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
3623
3628
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
3629
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
3624
3630
|
* @param {*} [options] Override http request option.
|
|
3625
3631
|
* @throws {RequiredError}
|
|
3626
3632
|
*/
|
|
3627
|
-
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> => {
|
|
3633
|
+
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> => {
|
|
3628
3634
|
// verify required parameter 'project' is not null or undefined
|
|
3629
3635
|
assertParamExists('listOrders', 'project', project)
|
|
3630
3636
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -3689,6 +3695,10 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3689
3695
|
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
3690
3696
|
}
|
|
3691
3697
|
|
|
3698
|
+
if (sortBy) {
|
|
3699
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3700
|
+
}
|
|
3701
|
+
|
|
3692
3702
|
|
|
3693
3703
|
|
|
3694
3704
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4144,11 +4154,12 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
4144
4154
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4145
4155
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
4146
4156
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
4157
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
4147
4158
|
* @param {*} [options] Override http request option.
|
|
4148
4159
|
* @throws {RequiredError}
|
|
4149
4160
|
*/
|
|
4150
|
-
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>> {
|
|
4151
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
4161
|
+
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>> {
|
|
4162
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, sortBy, options);
|
|
4152
4163
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4153
4164
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
4154
4165
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4339,7 +4350,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
4339
4350
|
* @throws {RequiredError}
|
|
4340
4351
|
*/
|
|
4341
4352
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
4342
|
-
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));
|
|
4353
|
+
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));
|
|
4343
4354
|
},
|
|
4344
4355
|
/**
|
|
4345
4356
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -4652,6 +4663,11 @@ export interface OrdersApiListOrdersRequest {
|
|
|
4652
4663
|
* The minimum value of the order
|
|
4653
4664
|
*/
|
|
4654
4665
|
readonly minOrderTotal?: number
|
|
4666
|
+
|
|
4667
|
+
/**
|
|
4668
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
4669
|
+
*/
|
|
4670
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>
|
|
4655
4671
|
}
|
|
4656
4672
|
|
|
4657
4673
|
/**
|
|
@@ -4879,7 +4895,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
4879
4895
|
* @throws {RequiredError}
|
|
4880
4896
|
*/
|
|
4881
4897
|
public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4882
|
-
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));
|
|
4898
|
+
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));
|
|
4883
4899
|
}
|
|
4884
4900
|
|
|
4885
4901
|
/**
|
|
@@ -4956,6 +4972,11 @@ export const ListOrdersDateFilterTypeEnum = {
|
|
|
4956
4972
|
RefundedAt: 'refundedAt'
|
|
4957
4973
|
} as const;
|
|
4958
4974
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
4975
|
+
export const ListOrdersSortByEnum = {
|
|
4976
|
+
CreatedAt: '+createdAt',
|
|
4977
|
+
CreatedAt2: '-createdAt'
|
|
4978
|
+
} as const;
|
|
4979
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
4959
4980
|
|
|
4960
4981
|
|
|
4961
4982
|
/**
|
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.52.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -481,6 +481,10 @@ export interface Fulfillment {
|
|
|
481
481
|
* Weight of the package being shipped in grams
|
|
482
482
|
*/
|
|
483
483
|
'packageWeight'?: number;
|
|
484
|
+
/**
|
|
485
|
+
* A reference to the resource location
|
|
486
|
+
*/
|
|
487
|
+
'platformRef'?: string;
|
|
484
488
|
}
|
|
485
489
|
export interface FulfillmentItem {
|
|
486
490
|
/**
|
|
@@ -567,6 +571,7 @@ export interface Order {
|
|
|
567
571
|
'ref'?: string;
|
|
568
572
|
'status'?: OrderStatus;
|
|
569
573
|
'approvalItemId'?: string | null;
|
|
574
|
+
'customerRef': string;
|
|
570
575
|
'contactInformation': ContactInformation;
|
|
571
576
|
'paymentMethod'?: OrderPaymentMethod;
|
|
572
577
|
'shippingAddress': Address;
|
|
@@ -2184,10 +2189,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2184
2189
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2185
2190
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2186
2191
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2192
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2187
2193
|
* @param {*} [options] Override http request option.
|
|
2188
2194
|
* @throws {RequiredError}
|
|
2189
2195
|
*/
|
|
2190
|
-
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>;
|
|
2196
|
+
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>;
|
|
2191
2197
|
/**
|
|
2192
2198
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2193
2199
|
* @summary Retry
|
|
@@ -2355,10 +2361,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2355
2361
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2356
2362
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2357
2363
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2364
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2358
2365
|
* @param {*} [options] Override http request option.
|
|
2359
2366
|
* @throws {RequiredError}
|
|
2360
2367
|
*/
|
|
2361
|
-
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>>;
|
|
2368
|
+
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>>;
|
|
2362
2369
|
/**
|
|
2363
2370
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2364
2371
|
* @summary Retry
|
|
@@ -2756,6 +2763,10 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2756
2763
|
* The minimum value of the order
|
|
2757
2764
|
*/
|
|
2758
2765
|
readonly minOrderTotal?: number;
|
|
2766
|
+
/**
|
|
2767
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2768
|
+
*/
|
|
2769
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>;
|
|
2759
2770
|
}
|
|
2760
2771
|
/**
|
|
2761
2772
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
@@ -2995,6 +3006,11 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
2995
3006
|
readonly RefundedAt: "refundedAt";
|
|
2996
3007
|
};
|
|
2997
3008
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
3009
|
+
export declare const ListOrdersSortByEnum: {
|
|
3010
|
+
readonly CreatedAt: "+createdAt";
|
|
3011
|
+
readonly CreatedAt2: "-createdAt";
|
|
3012
|
+
};
|
|
3013
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
2998
3014
|
/**
|
|
2999
3015
|
* PaymentApi - axios parameter creator
|
|
3000
3016
|
*/
|
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.52.0
|
|
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.52.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -481,6 +481,10 @@ export interface Fulfillment {
|
|
|
481
481
|
* Weight of the package being shipped in grams
|
|
482
482
|
*/
|
|
483
483
|
'packageWeight'?: number;
|
|
484
|
+
/**
|
|
485
|
+
* A reference to the resource location
|
|
486
|
+
*/
|
|
487
|
+
'platformRef'?: string;
|
|
484
488
|
}
|
|
485
489
|
export interface FulfillmentItem {
|
|
486
490
|
/**
|
|
@@ -567,6 +571,7 @@ export interface Order {
|
|
|
567
571
|
'ref'?: string;
|
|
568
572
|
'status'?: OrderStatus;
|
|
569
573
|
'approvalItemId'?: string | null;
|
|
574
|
+
'customerRef': string;
|
|
570
575
|
'contactInformation': ContactInformation;
|
|
571
576
|
'paymentMethod'?: OrderPaymentMethod;
|
|
572
577
|
'shippingAddress': Address;
|
|
@@ -2184,10 +2189,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2184
2189
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2185
2190
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2186
2191
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2192
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2187
2193
|
* @param {*} [options] Override http request option.
|
|
2188
2194
|
* @throws {RequiredError}
|
|
2189
2195
|
*/
|
|
2190
|
-
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>;
|
|
2196
|
+
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>;
|
|
2191
2197
|
/**
|
|
2192
2198
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2193
2199
|
* @summary Retry
|
|
@@ -2355,10 +2361,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2355
2361
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2356
2362
|
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
2357
2363
|
* @param {number} [minOrderTotal] The minimum value of the order
|
|
2364
|
+
* @param {Array<ListOrdersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2358
2365
|
* @param {*} [options] Override http request option.
|
|
2359
2366
|
* @throws {RequiredError}
|
|
2360
2367
|
*/
|
|
2361
|
-
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>>;
|
|
2368
|
+
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>>;
|
|
2362
2369
|
/**
|
|
2363
2370
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2364
2371
|
* @summary Retry
|
|
@@ -2756,6 +2763,10 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2756
2763
|
* The minimum value of the order
|
|
2757
2764
|
*/
|
|
2758
2765
|
readonly minOrderTotal?: number;
|
|
2766
|
+
/**
|
|
2767
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is descending.
|
|
2768
|
+
*/
|
|
2769
|
+
readonly sortBy?: Array<ListOrdersSortByEnum>;
|
|
2759
2770
|
}
|
|
2760
2771
|
/**
|
|
2761
2772
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
@@ -2995,6 +3006,11 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
2995
3006
|
readonly RefundedAt: "refundedAt";
|
|
2996
3007
|
};
|
|
2997
3008
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
3009
|
+
export declare const ListOrdersSortByEnum: {
|
|
3010
|
+
readonly CreatedAt: "+createdAt";
|
|
3011
|
+
readonly CreatedAt2: "-createdAt";
|
|
3012
|
+
};
|
|
3013
|
+
export type ListOrdersSortByEnum = typeof ListOrdersSortByEnum[keyof typeof ListOrdersSortByEnum];
|
|
2998
3014
|
/**
|
|
2999
3015
|
* PaymentApi - axios parameter creator
|
|
3000
3016
|
*/
|
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.52.0
|
|
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/Fulfillment.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | Shipping method currently set | [optional] [default to undefined]
|
|
15
15
|
**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment. | [optional] [default to undefined]
|
|
16
16
|
**packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
|
|
17
|
+
**platformRef** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,6 +31,7 @@ const instance: Fulfillment = {
|
|
|
30
31
|
shippingMethod,
|
|
31
32
|
availableShippingMethods,
|
|
32
33
|
packageWeight,
|
|
34
|
+
platformRef,
|
|
33
35
|
};
|
|
34
36
|
```
|
|
35
37
|
|
package/docs/Order.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
10
10
|
**status** | [**OrderStatus**](OrderStatus.md) | | [optional] [default to undefined]
|
|
11
11
|
**approvalItemId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**customerRef** | **string** | | [default to undefined]
|
|
12
13
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
13
14
|
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
14
15
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
@@ -43,6 +44,7 @@ const instance: Order = {
|
|
|
43
44
|
ref,
|
|
44
45
|
status,
|
|
45
46
|
approvalItemId,
|
|
47
|
+
customerRef,
|
|
46
48
|
contactInformation,
|
|
47
49
|
paymentMethod,
|
|
48
50
|
shippingAddress,
|
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