@teemill/platform 0.44.0 → 0.46.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 +6 -2
- package/api.ts +175 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +100 -1
- package/dist/api.js +127 -4
- 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 +100 -1
- package/dist/esm/api.js +121 -2
- 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 +4 -0
- package/docs/CreateOrderPaymentMethod.md +20 -0
- package/docs/ModerationApi.md +71 -0
- package/docs/Order.md +4 -0
- package/docs/OrderPaymentMethod.md +20 -0
- package/docs/OrderStatus.md +2 -0
- package/docs/UpdateModerationItemRequest.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.46.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -200,6 +200,7 @@ export interface CreateOrder {
|
|
|
200
200
|
*/
|
|
201
201
|
'merchantReference'?: string | null;
|
|
202
202
|
'contactInformation': CreateOrderContactInformation;
|
|
203
|
+
'paymentMethod'?: CreateOrderPaymentMethod;
|
|
203
204
|
'shippingAddress': Address;
|
|
204
205
|
'billingAddress'?: Address;
|
|
205
206
|
'customsInformation'?: CustomsInformation;
|
|
@@ -220,6 +221,10 @@ export interface CreateOrder {
|
|
|
220
221
|
* Determine whether this order will go through the bulk production flow or not
|
|
221
222
|
*/
|
|
222
223
|
'bulk'?: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* The discount to be applied to the order.
|
|
226
|
+
*/
|
|
227
|
+
'discount'?: number;
|
|
223
228
|
}
|
|
224
229
|
export interface CreateOrderChatChannel200Response {
|
|
225
230
|
/**
|
|
@@ -234,6 +239,15 @@ export interface CreateOrderContactInformation {
|
|
|
234
239
|
'email': string;
|
|
235
240
|
'phone'?: string | null;
|
|
236
241
|
}
|
|
242
|
+
export interface CreateOrderPaymentMethod {
|
|
243
|
+
'type': CreateOrderPaymentMethodTypeEnum;
|
|
244
|
+
}
|
|
245
|
+
export declare const CreateOrderPaymentMethodTypeEnum: {
|
|
246
|
+
readonly Card: "card";
|
|
247
|
+
readonly Bacs: "bacs";
|
|
248
|
+
readonly Terms: "terms";
|
|
249
|
+
};
|
|
250
|
+
export type CreateOrderPaymentMethodTypeEnum = typeof CreateOrderPaymentMethodTypeEnum[keyof typeof CreateOrderPaymentMethodTypeEnum];
|
|
237
251
|
export interface CreatePixelRequest {
|
|
238
252
|
'name': string;
|
|
239
253
|
'sourceProjects': Array<string>;
|
|
@@ -540,7 +554,9 @@ export interface Order {
|
|
|
540
554
|
*/
|
|
541
555
|
'ref'?: string;
|
|
542
556
|
'status'?: OrderStatus;
|
|
557
|
+
'approvalItemId'?: string | null;
|
|
543
558
|
'contactInformation': ContactInformation;
|
|
559
|
+
'paymentMethod'?: OrderPaymentMethod | null;
|
|
544
560
|
'shippingAddress': Address;
|
|
545
561
|
'billingAddress'?: Address;
|
|
546
562
|
/**
|
|
@@ -629,12 +645,16 @@ export interface OrderItem1RecipientCost {
|
|
|
629
645
|
'amount': string;
|
|
630
646
|
'currencyCode': string;
|
|
631
647
|
}
|
|
648
|
+
export interface OrderPaymentMethod {
|
|
649
|
+
'type': string;
|
|
650
|
+
}
|
|
632
651
|
export declare const OrderStatus: {
|
|
633
652
|
readonly New: "new";
|
|
634
653
|
readonly Paid: "paid";
|
|
635
654
|
readonly Processing: "processing";
|
|
636
655
|
readonly Complete: "complete";
|
|
637
656
|
readonly Refunded: "refunded";
|
|
657
|
+
readonly Moderation: "moderation";
|
|
638
658
|
};
|
|
639
659
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
640
660
|
export interface OrderTracking {
|
|
@@ -951,6 +971,15 @@ export interface UpdateFulfillmentRequest {
|
|
|
951
971
|
*/
|
|
952
972
|
'fulfillerId'?: string;
|
|
953
973
|
}
|
|
974
|
+
export interface UpdateModerationItemRequest {
|
|
975
|
+
'judgement': UpdateModerationItemRequestJudgementEnum;
|
|
976
|
+
'denialReason'?: string;
|
|
977
|
+
}
|
|
978
|
+
export declare const UpdateModerationItemRequestJudgementEnum: {
|
|
979
|
+
readonly Approved: "approved";
|
|
980
|
+
readonly Denied: "denied";
|
|
981
|
+
};
|
|
982
|
+
export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationItemRequestJudgementEnum[keyof typeof UpdateModerationItemRequestJudgementEnum];
|
|
954
983
|
export interface UpdatePlatformFulfillmentStyleApplicationRequest {
|
|
955
984
|
'design'?: string;
|
|
956
985
|
}
|
|
@@ -1899,6 +1928,76 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
1899
1928
|
*/
|
|
1900
1929
|
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any, {}>>;
|
|
1901
1930
|
}
|
|
1931
|
+
/**
|
|
1932
|
+
* ModerationApi - axios parameter creator
|
|
1933
|
+
*/
|
|
1934
|
+
export declare const ModerationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1935
|
+
/**
|
|
1936
|
+
* Update a moderation item
|
|
1937
|
+
* @summary Update a moderation item
|
|
1938
|
+
* @param {string} project Project unique identifier
|
|
1939
|
+
* @param {string} moderationItemId The moderation item identifier
|
|
1940
|
+
* @param {UpdateModerationItemRequest} [updateModerationItemRequest]
|
|
1941
|
+
* @param {*} [options] Override http request option.
|
|
1942
|
+
* @throws {RequiredError}
|
|
1943
|
+
*/
|
|
1944
|
+
updateModerationItem: (project: string, moderationItemId: string, updateModerationItemRequest?: UpdateModerationItemRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1945
|
+
};
|
|
1946
|
+
/**
|
|
1947
|
+
* ModerationApi - functional programming interface
|
|
1948
|
+
*/
|
|
1949
|
+
export declare const ModerationApiFp: (configuration?: Configuration) => {
|
|
1950
|
+
/**
|
|
1951
|
+
* Update a moderation item
|
|
1952
|
+
* @summary Update a moderation item
|
|
1953
|
+
* @param {string} project Project unique identifier
|
|
1954
|
+
* @param {string} moderationItemId The moderation item identifier
|
|
1955
|
+
* @param {UpdateModerationItemRequest} [updateModerationItemRequest]
|
|
1956
|
+
* @param {*} [options] Override http request option.
|
|
1957
|
+
* @throws {RequiredError}
|
|
1958
|
+
*/
|
|
1959
|
+
updateModerationItem(project: string, moderationItemId: string, updateModerationItemRequest?: UpdateModerationItemRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1960
|
+
};
|
|
1961
|
+
/**
|
|
1962
|
+
* ModerationApi - factory interface
|
|
1963
|
+
*/
|
|
1964
|
+
export declare const ModerationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1965
|
+
/**
|
|
1966
|
+
* Update a moderation item
|
|
1967
|
+
* @summary Update a moderation item
|
|
1968
|
+
* @param {ModerationApiUpdateModerationItemRequest} requestParameters Request parameters.
|
|
1969
|
+
* @param {*} [options] Override http request option.
|
|
1970
|
+
* @throws {RequiredError}
|
|
1971
|
+
*/
|
|
1972
|
+
updateModerationItem(requestParameters: ModerationApiUpdateModerationItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1973
|
+
};
|
|
1974
|
+
/**
|
|
1975
|
+
* Request parameters for updateModerationItem operation in ModerationApi.
|
|
1976
|
+
*/
|
|
1977
|
+
export interface ModerationApiUpdateModerationItemRequest {
|
|
1978
|
+
/**
|
|
1979
|
+
* Project unique identifier
|
|
1980
|
+
*/
|
|
1981
|
+
readonly project: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* The moderation item identifier
|
|
1984
|
+
*/
|
|
1985
|
+
readonly moderationItemId: string;
|
|
1986
|
+
readonly updateModerationItemRequest?: UpdateModerationItemRequest;
|
|
1987
|
+
}
|
|
1988
|
+
/**
|
|
1989
|
+
* ModerationApi - object-oriented interface
|
|
1990
|
+
*/
|
|
1991
|
+
export declare class ModerationApi extends BaseAPI {
|
|
1992
|
+
/**
|
|
1993
|
+
* Update a moderation item
|
|
1994
|
+
* @summary Update a moderation item
|
|
1995
|
+
* @param {ModerationApiUpdateModerationItemRequest} requestParameters Request parameters.
|
|
1996
|
+
* @param {*} [options] Override http request option.
|
|
1997
|
+
* @throws {RequiredError}
|
|
1998
|
+
*/
|
|
1999
|
+
updateModerationItem(requestParameters: ModerationApiUpdateModerationItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2000
|
+
}
|
|
1902
2001
|
/**
|
|
1903
2002
|
* OrdersApi - axios parameter creator
|
|
1904
2003
|
*/
|
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.46.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -38,6 +38,11 @@ export const ApplicationPlacementEnum = {
|
|
|
38
38
|
Front: 'front',
|
|
39
39
|
Back: 'back'
|
|
40
40
|
};
|
|
41
|
+
export const CreateOrderPaymentMethodTypeEnum = {
|
|
42
|
+
Card: 'card',
|
|
43
|
+
Bacs: 'bacs',
|
|
44
|
+
Terms: 'terms'
|
|
45
|
+
};
|
|
41
46
|
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
42
47
|
Ioss: 'IOSS'
|
|
43
48
|
};
|
|
@@ -51,7 +56,8 @@ export const OrderStatus = {
|
|
|
51
56
|
Paid: 'paid',
|
|
52
57
|
Processing: 'processing',
|
|
53
58
|
Complete: 'complete',
|
|
54
|
-
Refunded: 'refunded'
|
|
59
|
+
Refunded: 'refunded',
|
|
60
|
+
Moderation: 'moderation'
|
|
55
61
|
};
|
|
56
62
|
export const PaymentAccountMethodEnum = {
|
|
57
63
|
Stripe: 'stripe'
|
|
@@ -71,6 +77,10 @@ export const ReturnOrderRequestReturnsInnerActionEnum = {
|
|
|
71
77
|
Refund: 'refund',
|
|
72
78
|
Exchange: 'exchange'
|
|
73
79
|
};
|
|
80
|
+
export const UpdateModerationItemRequestJudgementEnum = {
|
|
81
|
+
Approved: 'approved',
|
|
82
|
+
Denied: 'denied'
|
|
83
|
+
};
|
|
74
84
|
/**
|
|
75
85
|
* CustomersApi - axios parameter creator
|
|
76
86
|
*/
|
|
@@ -1294,6 +1304,115 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
1294
1304
|
return EnquiriesApiFp(this.configuration).updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1295
1305
|
}
|
|
1296
1306
|
}
|
|
1307
|
+
/**
|
|
1308
|
+
* ModerationApi - axios parameter creator
|
|
1309
|
+
*/
|
|
1310
|
+
export const ModerationApiAxiosParamCreator = function (configuration) {
|
|
1311
|
+
return {
|
|
1312
|
+
/**
|
|
1313
|
+
* Update a moderation item
|
|
1314
|
+
* @summary Update a moderation item
|
|
1315
|
+
* @param {string} project Project unique identifier
|
|
1316
|
+
* @param {string} moderationItemId The moderation item identifier
|
|
1317
|
+
* @param {UpdateModerationItemRequest} [updateModerationItemRequest]
|
|
1318
|
+
* @param {*} [options] Override http request option.
|
|
1319
|
+
* @throws {RequiredError}
|
|
1320
|
+
*/
|
|
1321
|
+
updateModerationItem: (project_1, moderationItemId_1, updateModerationItemRequest_1, ...args_1) => __awaiter(this, [project_1, moderationItemId_1, updateModerationItemRequest_1, ...args_1], void 0, function* (project, moderationItemId, updateModerationItemRequest, options = {}) {
|
|
1322
|
+
// verify required parameter 'project' is not null or undefined
|
|
1323
|
+
assertParamExists('updateModerationItem', 'project', project);
|
|
1324
|
+
// verify required parameter 'moderationItemId' is not null or undefined
|
|
1325
|
+
assertParamExists('updateModerationItem', 'moderationItemId', moderationItemId);
|
|
1326
|
+
const localVarPath = `/v1/platform/moderate/{moderationItemId}`
|
|
1327
|
+
.replace(`{${"moderationItemId"}}`, encodeURIComponent(String(moderationItemId)));
|
|
1328
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1329
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1330
|
+
let baseOptions;
|
|
1331
|
+
if (configuration) {
|
|
1332
|
+
baseOptions = configuration.baseOptions;
|
|
1333
|
+
}
|
|
1334
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1335
|
+
const localVarHeaderParameter = {};
|
|
1336
|
+
const localVarQueryParameter = {};
|
|
1337
|
+
// authentication session-oauth required
|
|
1338
|
+
// oauth required
|
|
1339
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1340
|
+
// authentication api-key required
|
|
1341
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1342
|
+
if (project !== undefined) {
|
|
1343
|
+
localVarQueryParameter['project'] = project;
|
|
1344
|
+
}
|
|
1345
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1346
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1347
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1348
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1349
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateModerationItemRequest, localVarRequestOptions, configuration);
|
|
1350
|
+
return {
|
|
1351
|
+
url: toPathString(localVarUrlObj),
|
|
1352
|
+
options: localVarRequestOptions,
|
|
1353
|
+
};
|
|
1354
|
+
}),
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
/**
|
|
1358
|
+
* ModerationApi - functional programming interface
|
|
1359
|
+
*/
|
|
1360
|
+
export const ModerationApiFp = function (configuration) {
|
|
1361
|
+
const localVarAxiosParamCreator = ModerationApiAxiosParamCreator(configuration);
|
|
1362
|
+
return {
|
|
1363
|
+
/**
|
|
1364
|
+
* Update a moderation item
|
|
1365
|
+
* @summary Update a moderation item
|
|
1366
|
+
* @param {string} project Project unique identifier
|
|
1367
|
+
* @param {string} moderationItemId The moderation item identifier
|
|
1368
|
+
* @param {UpdateModerationItemRequest} [updateModerationItemRequest]
|
|
1369
|
+
* @param {*} [options] Override http request option.
|
|
1370
|
+
* @throws {RequiredError}
|
|
1371
|
+
*/
|
|
1372
|
+
updateModerationItem(project, moderationItemId, updateModerationItemRequest, options) {
|
|
1373
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1374
|
+
var _a, _b, _c;
|
|
1375
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateModerationItem(project, moderationItemId, updateModerationItemRequest, options);
|
|
1376
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1377
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ModerationApi.updateModerationItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1378
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1379
|
+
});
|
|
1380
|
+
},
|
|
1381
|
+
};
|
|
1382
|
+
};
|
|
1383
|
+
/**
|
|
1384
|
+
* ModerationApi - factory interface
|
|
1385
|
+
*/
|
|
1386
|
+
export const ModerationApiFactory = function (configuration, basePath, axios) {
|
|
1387
|
+
const localVarFp = ModerationApiFp(configuration);
|
|
1388
|
+
return {
|
|
1389
|
+
/**
|
|
1390
|
+
* Update a moderation item
|
|
1391
|
+
* @summary Update a moderation item
|
|
1392
|
+
* @param {ModerationApiUpdateModerationItemRequest} requestParameters Request parameters.
|
|
1393
|
+
* @param {*} [options] Override http request option.
|
|
1394
|
+
* @throws {RequiredError}
|
|
1395
|
+
*/
|
|
1396
|
+
updateModerationItem(requestParameters, options) {
|
|
1397
|
+
return localVarFp.updateModerationItem(requestParameters.project, requestParameters.moderationItemId, requestParameters.updateModerationItemRequest, options).then((request) => request(axios, basePath));
|
|
1398
|
+
},
|
|
1399
|
+
};
|
|
1400
|
+
};
|
|
1401
|
+
/**
|
|
1402
|
+
* ModerationApi - object-oriented interface
|
|
1403
|
+
*/
|
|
1404
|
+
export class ModerationApi extends BaseAPI {
|
|
1405
|
+
/**
|
|
1406
|
+
* Update a moderation item
|
|
1407
|
+
* @summary Update a moderation item
|
|
1408
|
+
* @param {ModerationApiUpdateModerationItemRequest} requestParameters Request parameters.
|
|
1409
|
+
* @param {*} [options] Override http request option.
|
|
1410
|
+
* @throws {RequiredError}
|
|
1411
|
+
*/
|
|
1412
|
+
updateModerationItem(requestParameters, options) {
|
|
1413
|
+
return ModerationApiFp(this.configuration).updateModerationItem(requestParameters.project, requestParameters.moderationItemId, requestParameters.updateModerationItemRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
1297
1416
|
/**
|
|
1298
1417
|
* OrdersApi - axios parameter creator
|
|
1299
1418
|
*/
|
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
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
|
|
10
10
|
**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) | | [default to undefined]
|
|
11
|
+
**paymentMethod** | [**CreateOrderPaymentMethod**](CreateOrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
11
12
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
12
13
|
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
13
14
|
**customsInformation** | [**CustomsInformation**](CustomsInformation.md) | | [optional] [default to undefined]
|
|
@@ -16,6 +17,7 @@ Name | Type | Description | Notes
|
|
|
16
17
|
**originalOrderRef** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
17
18
|
**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
19
|
**bulk** | **boolean** | Determine whether this order will go through the bulk production flow or not | [optional] [default to undefined]
|
|
20
|
+
**discount** | **number** | The discount to be applied to the order. | [optional] [default to undefined]
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -25,6 +27,7 @@ import { CreateOrder } from '@teemill/platform';
|
|
|
25
27
|
const instance: CreateOrder = {
|
|
26
28
|
merchantReference,
|
|
27
29
|
contactInformation,
|
|
30
|
+
paymentMethod,
|
|
28
31
|
shippingAddress,
|
|
29
32
|
billingAddress,
|
|
30
33
|
customsInformation,
|
|
@@ -33,6 +36,7 @@ const instance: CreateOrder = {
|
|
|
33
36
|
originalOrderRef,
|
|
34
37
|
client,
|
|
35
38
|
bulk,
|
|
39
|
+
discount,
|
|
36
40
|
};
|
|
37
41
|
```
|
|
38
42
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateOrderPaymentMethod
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CreateOrderPaymentMethod } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: CreateOrderPaymentMethod = {
|
|
16
|
+
type,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# ModerationApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**updateModerationItem**](#updatemoderationitem) | **PATCH** /v1/platform/moderate/{moderationItemId} | Update a moderation item|
|
|
8
|
+
|
|
9
|
+
# **updateModerationItem**
|
|
10
|
+
> updateModerationItem()
|
|
11
|
+
|
|
12
|
+
Update a moderation item
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ModerationApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
UpdateModerationItemRequest
|
|
21
|
+
} from '@teemill/platform';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new ModerationApi(configuration);
|
|
25
|
+
|
|
26
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
27
|
+
let moderationItemId: string; //The moderation item identifier (default to undefined)
|
|
28
|
+
let updateModerationItemRequest: UpdateModerationItemRequest; // (optional)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.updateModerationItem(
|
|
31
|
+
project,
|
|
32
|
+
moderationItemId,
|
|
33
|
+
updateModerationItemRequest
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **updateModerationItemRequest** | **UpdateModerationItemRequest**| | |
|
|
42
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
43
|
+
| **moderationItemId** | [**string**] | The moderation item identifier | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
void (empty response body)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**204** | Item has been moderated | - |
|
|
64
|
+
|**400** | Failed validation | - |
|
|
65
|
+
|**401** | Not authorised to access this resource | - |
|
|
66
|
+
|**403** | Refuse to authorize | - |
|
|
67
|
+
|**404** | Resource not found | - |
|
|
68
|
+
|**500** | Unknown server error | - |
|
|
69
|
+
|
|
70
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
71
|
+
|
package/docs/Order.md
CHANGED
|
@@ -8,7 +8,9 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
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
|
+
**approvalItemId** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
13
|
+
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
12
14
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
13
15
|
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
14
16
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
@@ -39,7 +41,9 @@ const instance: Order = {
|
|
|
39
41
|
id,
|
|
40
42
|
ref,
|
|
41
43
|
status,
|
|
44
|
+
approvalItemId,
|
|
42
45
|
contactInformation,
|
|
46
|
+
paymentMethod,
|
|
43
47
|
shippingAddress,
|
|
44
48
|
billingAddress,
|
|
45
49
|
createdAt,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# OrderPaymentMethod
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { OrderPaymentMethod } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: OrderPaymentMethod = {
|
|
16
|
+
type,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OrderStatus.md
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdateModerationItemRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**judgement** | **string** | | [default to undefined]
|
|
9
|
+
**denialReason** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateModerationItemRequest } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateModerationItemRequest = {
|
|
17
|
+
judgement,
|
|
18
|
+
denialReason,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED