@teemill/platform 0.45.2 → 0.47.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 +5 -2
- package/api.ts +134 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +76 -1
- package/dist/api.js +90 -3
- 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 +76 -1
- package/dist/esm/api.js +88 -1
- 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/Customer.md +2 -0
- package/docs/CustomersApi.md +63 -0
- package/docs/Order.md +2 -0
- package/docs/OrderPaymentMethod.md +20 -0
- 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.47.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.47.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -51,6 +51,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*CustomersApi* | [**createCustomerChatChannel**](docs/CustomersApi.md#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel
|
|
54
55
|
*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
|
|
55
56
|
*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
|
|
56
57
|
*CustomersApi* | [**listCustomerTags**](docs/CustomersApi.md#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags
|
|
@@ -126,6 +127,7 @@ Class | Method | HTTP request | Description
|
|
|
126
127
|
- [CreateOrder](docs/CreateOrder.md)
|
|
127
128
|
- [CreateOrderChatChannel200Response](docs/CreateOrderChatChannel200Response.md)
|
|
128
129
|
- [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
|
|
130
|
+
- [CreateOrderPaymentMethod](docs/CreateOrderPaymentMethod.md)
|
|
129
131
|
- [CreatePixelRequest](docs/CreatePixelRequest.md)
|
|
130
132
|
- [CreatePixelRequestFilters](docs/CreatePixelRequestFilters.md)
|
|
131
133
|
- [CreateReview201Response](docs/CreateReview201Response.md)
|
|
@@ -162,6 +164,7 @@ Class | Method | HTTP request | Description
|
|
|
162
164
|
- [OrderItem](docs/OrderItem.md)
|
|
163
165
|
- [OrderItem1](docs/OrderItem1.md)
|
|
164
166
|
- [OrderItem1RecipientCost](docs/OrderItem1RecipientCost.md)
|
|
167
|
+
- [OrderPaymentMethod](docs/OrderPaymentMethod.md)
|
|
165
168
|
- [OrderStatus](docs/OrderStatus.md)
|
|
166
169
|
- [OrderTracking](docs/OrderTracking.md)
|
|
167
170
|
- [OrdersResponse](docs/OrdersResponse.md)
|
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.47.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -219,6 +219,7 @@ export interface CreateOrder {
|
|
|
219
219
|
*/
|
|
220
220
|
'merchantReference'?: string | null;
|
|
221
221
|
'contactInformation': CreateOrderContactInformation;
|
|
222
|
+
'paymentMethod'?: CreateOrderPaymentMethod;
|
|
222
223
|
'shippingAddress': Address;
|
|
223
224
|
'billingAddress'?: Address;
|
|
224
225
|
'customsInformation'?: CustomsInformation;
|
|
@@ -239,6 +240,10 @@ export interface CreateOrder {
|
|
|
239
240
|
* Determine whether this order will go through the bulk production flow or not
|
|
240
241
|
*/
|
|
241
242
|
'bulk'?: boolean;
|
|
243
|
+
/**
|
|
244
|
+
* The discount to be applied to the order.
|
|
245
|
+
*/
|
|
246
|
+
'discount'?: number;
|
|
242
247
|
}
|
|
243
248
|
export interface CreateOrderChatChannel200Response {
|
|
244
249
|
/**
|
|
@@ -253,6 +258,18 @@ export interface CreateOrderContactInformation {
|
|
|
253
258
|
'email': string;
|
|
254
259
|
'phone'?: string | null;
|
|
255
260
|
}
|
|
261
|
+
export interface CreateOrderPaymentMethod {
|
|
262
|
+
'type': CreateOrderPaymentMethodTypeEnum;
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
export const CreateOrderPaymentMethodTypeEnum = {
|
|
266
|
+
Card: 'card',
|
|
267
|
+
Bacs: 'bacs',
|
|
268
|
+
Terms: 'terms'
|
|
269
|
+
} as const;
|
|
270
|
+
|
|
271
|
+
export type CreateOrderPaymentMethodTypeEnum = typeof CreateOrderPaymentMethodTypeEnum[keyof typeof CreateOrderPaymentMethodTypeEnum];
|
|
272
|
+
|
|
256
273
|
export interface CreatePixelRequest {
|
|
257
274
|
'name': string;
|
|
258
275
|
'sourceProjects': Array<string>;
|
|
@@ -327,6 +344,10 @@ export interface Customer {
|
|
|
327
344
|
'country': string | null;
|
|
328
345
|
'statistics': Statistics;
|
|
329
346
|
'shippingAddress'?: Address;
|
|
347
|
+
/**
|
|
348
|
+
* Reference to the chat channel resource
|
|
349
|
+
*/
|
|
350
|
+
'chatChannelRef'?: string | null;
|
|
330
351
|
}
|
|
331
352
|
export interface CustomersResponse {
|
|
332
353
|
'customers': Array<Customer>;
|
|
@@ -570,6 +591,7 @@ export interface Order {
|
|
|
570
591
|
'status'?: OrderStatus;
|
|
571
592
|
'approvalItemId'?: string | null;
|
|
572
593
|
'contactInformation': ContactInformation;
|
|
594
|
+
'paymentMethod'?: OrderPaymentMethod | null;
|
|
573
595
|
'shippingAddress': Address;
|
|
574
596
|
'billingAddress'?: Address;
|
|
575
597
|
/**
|
|
@@ -660,6 +682,9 @@ export interface OrderItem1RecipientCost {
|
|
|
660
682
|
'amount': string;
|
|
661
683
|
'currencyCode': string;
|
|
662
684
|
}
|
|
685
|
+
export interface OrderPaymentMethod {
|
|
686
|
+
'type': string;
|
|
687
|
+
}
|
|
663
688
|
|
|
664
689
|
export const OrderStatus = {
|
|
665
690
|
New: 'new',
|
|
@@ -1048,6 +1073,58 @@ export interface Variant {
|
|
|
1048
1073
|
*/
|
|
1049
1074
|
export const CustomersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1050
1075
|
return {
|
|
1076
|
+
/**
|
|
1077
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1078
|
+
* @summary Create chat channel
|
|
1079
|
+
* @param {string} project Project unique identifier
|
|
1080
|
+
* @param {string} platformId The platform identifier
|
|
1081
|
+
* @param {string} customerId The customer identifier
|
|
1082
|
+
* @param {*} [options] Override http request option.
|
|
1083
|
+
* @throws {RequiredError}
|
|
1084
|
+
*/
|
|
1085
|
+
createCustomerChatChannel: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1086
|
+
// verify required parameter 'project' is not null or undefined
|
|
1087
|
+
assertParamExists('createCustomerChatChannel', 'project', project)
|
|
1088
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1089
|
+
assertParamExists('createCustomerChatChannel', 'platformId', platformId)
|
|
1090
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1091
|
+
assertParamExists('createCustomerChatChannel', 'customerId', customerId)
|
|
1092
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/chat-channel`
|
|
1093
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1094
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1095
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1096
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1097
|
+
let baseOptions;
|
|
1098
|
+
if (configuration) {
|
|
1099
|
+
baseOptions = configuration.baseOptions;
|
|
1100
|
+
}
|
|
1101
|
+
|
|
1102
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1103
|
+
const localVarHeaderParameter = {} as any;
|
|
1104
|
+
const localVarQueryParameter = {} as any;
|
|
1105
|
+
|
|
1106
|
+
// authentication session-oauth required
|
|
1107
|
+
// oauth required
|
|
1108
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1109
|
+
|
|
1110
|
+
// authentication api-key required
|
|
1111
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1112
|
+
|
|
1113
|
+
if (project !== undefined) {
|
|
1114
|
+
localVarQueryParameter['project'] = project;
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1120
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1121
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1122
|
+
|
|
1123
|
+
return {
|
|
1124
|
+
url: toPathString(localVarUrlObj),
|
|
1125
|
+
options: localVarRequestOptions,
|
|
1126
|
+
};
|
|
1127
|
+
},
|
|
1051
1128
|
/**
|
|
1052
1129
|
* Export customers as a CSV file
|
|
1053
1130
|
* @summary Export customers
|
|
@@ -1447,6 +1524,21 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1447
1524
|
export const CustomersApiFp = function(configuration?: Configuration) {
|
|
1448
1525
|
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration)
|
|
1449
1526
|
return {
|
|
1527
|
+
/**
|
|
1528
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1529
|
+
* @summary Create chat channel
|
|
1530
|
+
* @param {string} project Project unique identifier
|
|
1531
|
+
* @param {string} platformId The platform identifier
|
|
1532
|
+
* @param {string} customerId The customer identifier
|
|
1533
|
+
* @param {*} [options] Override http request option.
|
|
1534
|
+
* @throws {RequiredError}
|
|
1535
|
+
*/
|
|
1536
|
+
async createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
1537
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomerChatChannel(project, platformId, customerId, options);
|
|
1538
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1539
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.createCustomerChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
1540
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1541
|
+
},
|
|
1450
1542
|
/**
|
|
1451
1543
|
* Export customers as a CSV file
|
|
1452
1544
|
* @summary Export customers
|
|
@@ -1551,6 +1643,16 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1551
1643
|
export const CustomersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1552
1644
|
const localVarFp = CustomersApiFp(configuration)
|
|
1553
1645
|
return {
|
|
1646
|
+
/**
|
|
1647
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1648
|
+
* @summary Create chat channel
|
|
1649
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1650
|
+
* @param {*} [options] Override http request option.
|
|
1651
|
+
* @throws {RequiredError}
|
|
1652
|
+
*/
|
|
1653
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
1654
|
+
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1655
|
+
},
|
|
1554
1656
|
/**
|
|
1555
1657
|
* Export customers as a CSV file
|
|
1556
1658
|
* @summary Export customers
|
|
@@ -1594,6 +1696,26 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1594
1696
|
};
|
|
1595
1697
|
};
|
|
1596
1698
|
|
|
1699
|
+
/**
|
|
1700
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1701
|
+
*/
|
|
1702
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1703
|
+
/**
|
|
1704
|
+
* Project unique identifier
|
|
1705
|
+
*/
|
|
1706
|
+
readonly project: string
|
|
1707
|
+
|
|
1708
|
+
/**
|
|
1709
|
+
* The platform identifier
|
|
1710
|
+
*/
|
|
1711
|
+
readonly platformId: string
|
|
1712
|
+
|
|
1713
|
+
/**
|
|
1714
|
+
* The customer identifier
|
|
1715
|
+
*/
|
|
1716
|
+
readonly customerId: string
|
|
1717
|
+
}
|
|
1718
|
+
|
|
1597
1719
|
/**
|
|
1598
1720
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1599
1721
|
*/
|
|
@@ -1853,6 +1975,17 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1853
1975
|
* CustomersApi - object-oriented interface
|
|
1854
1976
|
*/
|
|
1855
1977
|
export class CustomersApi extends BaseAPI {
|
|
1978
|
+
/**
|
|
1979
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1980
|
+
* @summary Create chat channel
|
|
1981
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1982
|
+
* @param {*} [options] Override http request option.
|
|
1983
|
+
* @throws {RequiredError}
|
|
1984
|
+
*/
|
|
1985
|
+
public createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
1986
|
+
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1856
1989
|
/**
|
|
1857
1990
|
* Export customers as a CSV file
|
|
1858
1991
|
* @summary Export customers
|
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.47.0
|
|
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>;
|
|
@@ -306,6 +320,10 @@ export interface Customer {
|
|
|
306
320
|
'country': string | null;
|
|
307
321
|
'statistics': Statistics;
|
|
308
322
|
'shippingAddress'?: Address;
|
|
323
|
+
/**
|
|
324
|
+
* Reference to the chat channel resource
|
|
325
|
+
*/
|
|
326
|
+
'chatChannelRef'?: string | null;
|
|
309
327
|
}
|
|
310
328
|
export interface CustomersResponse {
|
|
311
329
|
'customers': Array<Customer>;
|
|
@@ -542,6 +560,7 @@ export interface Order {
|
|
|
542
560
|
'status'?: OrderStatus;
|
|
543
561
|
'approvalItemId'?: string | null;
|
|
544
562
|
'contactInformation': ContactInformation;
|
|
563
|
+
'paymentMethod'?: OrderPaymentMethod | null;
|
|
545
564
|
'shippingAddress': Address;
|
|
546
565
|
'billingAddress'?: Address;
|
|
547
566
|
/**
|
|
@@ -630,6 +649,9 @@ export interface OrderItem1RecipientCost {
|
|
|
630
649
|
'amount': string;
|
|
631
650
|
'currencyCode': string;
|
|
632
651
|
}
|
|
652
|
+
export interface OrderPaymentMethod {
|
|
653
|
+
'type': string;
|
|
654
|
+
}
|
|
633
655
|
export declare const OrderStatus: {
|
|
634
656
|
readonly New: "new";
|
|
635
657
|
readonly Paid: "paid";
|
|
@@ -1001,6 +1023,16 @@ export interface Variant {
|
|
|
1001
1023
|
* CustomersApi - axios parameter creator
|
|
1002
1024
|
*/
|
|
1003
1025
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1026
|
+
/**
|
|
1027
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1028
|
+
* @summary Create chat channel
|
|
1029
|
+
* @param {string} project Project unique identifier
|
|
1030
|
+
* @param {string} platformId The platform identifier
|
|
1031
|
+
* @param {string} customerId The customer identifier
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1004
1036
|
/**
|
|
1005
1037
|
* Export customers as a CSV file
|
|
1006
1038
|
* @summary Export customers
|
|
@@ -1081,6 +1113,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1081
1113
|
* CustomersApi - functional programming interface
|
|
1082
1114
|
*/
|
|
1083
1115
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
1116
|
+
/**
|
|
1117
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1118
|
+
* @summary Create chat channel
|
|
1119
|
+
* @param {string} project Project unique identifier
|
|
1120
|
+
* @param {string} platformId The platform identifier
|
|
1121
|
+
* @param {string} customerId The customer identifier
|
|
1122
|
+
* @param {*} [options] Override http request option.
|
|
1123
|
+
* @throws {RequiredError}
|
|
1124
|
+
*/
|
|
1125
|
+
createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1084
1126
|
/**
|
|
1085
1127
|
* Export customers as a CSV file
|
|
1086
1128
|
* @summary Export customers
|
|
@@ -1161,6 +1203,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1161
1203
|
* CustomersApi - factory interface
|
|
1162
1204
|
*/
|
|
1163
1205
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1206
|
+
/**
|
|
1207
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1208
|
+
* @summary Create chat channel
|
|
1209
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1210
|
+
* @param {*} [options] Override http request option.
|
|
1211
|
+
* @throws {RequiredError}
|
|
1212
|
+
*/
|
|
1213
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1164
1214
|
/**
|
|
1165
1215
|
* Export customers as a CSV file
|
|
1166
1216
|
* @summary Export customers
|
|
@@ -1194,6 +1244,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1194
1244
|
*/
|
|
1195
1245
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1196
1246
|
};
|
|
1247
|
+
/**
|
|
1248
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1249
|
+
*/
|
|
1250
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1251
|
+
/**
|
|
1252
|
+
* Project unique identifier
|
|
1253
|
+
*/
|
|
1254
|
+
readonly project: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* The platform identifier
|
|
1257
|
+
*/
|
|
1258
|
+
readonly platformId: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* The customer identifier
|
|
1261
|
+
*/
|
|
1262
|
+
readonly customerId: string;
|
|
1263
|
+
}
|
|
1197
1264
|
/**
|
|
1198
1265
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1199
1266
|
*/
|
|
@@ -1406,6 +1473,14 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1406
1473
|
* CustomersApi - object-oriented interface
|
|
1407
1474
|
*/
|
|
1408
1475
|
export declare class CustomersApi extends BaseAPI {
|
|
1476
|
+
/**
|
|
1477
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1478
|
+
* @summary Create chat channel
|
|
1479
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1409
1484
|
/**
|
|
1410
1485
|
* Export customers as a CSV file
|
|
1411
1486
|
* @summary Export customers
|
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.47.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 = void 0;
|
|
25
|
+
exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.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 = void 0;
|
|
27
27
|
const axios_1 = require("axios");
|
|
28
28
|
// Some imports not used depending on template conditions
|
|
29
29
|
// @ts-ignore
|
|
@@ -42,6 +42,11 @@ exports.ApplicationPlacementEnum = {
|
|
|
42
42
|
Front: 'front',
|
|
43
43
|
Back: 'back'
|
|
44
44
|
};
|
|
45
|
+
exports.CreateOrderPaymentMethodTypeEnum = {
|
|
46
|
+
Card: 'card',
|
|
47
|
+
Bacs: 'bacs',
|
|
48
|
+
Terms: 'terms'
|
|
49
|
+
};
|
|
45
50
|
exports.CustomsInformationPreRegistrationTypeEnum = {
|
|
46
51
|
Ioss: 'IOSS'
|
|
47
52
|
};
|
|
@@ -85,6 +90,50 @@ exports.UpdateModerationItemRequestJudgementEnum = {
|
|
|
85
90
|
*/
|
|
86
91
|
const CustomersApiAxiosParamCreator = function (configuration) {
|
|
87
92
|
return {
|
|
93
|
+
/**
|
|
94
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
95
|
+
* @summary Create chat channel
|
|
96
|
+
* @param {string} project Project unique identifier
|
|
97
|
+
* @param {string} platformId The platform identifier
|
|
98
|
+
* @param {string} customerId The customer identifier
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
createCustomerChatChannel: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
103
|
+
// verify required parameter 'project' is not null or undefined
|
|
104
|
+
(0, common_1.assertParamExists)('createCustomerChatChannel', 'project', project);
|
|
105
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
106
|
+
(0, common_1.assertParamExists)('createCustomerChatChannel', 'platformId', platformId);
|
|
107
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
108
|
+
(0, common_1.assertParamExists)('createCustomerChatChannel', 'customerId', customerId);
|
|
109
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/chat-channel`
|
|
110
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
111
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
112
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
113
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
114
|
+
let baseOptions;
|
|
115
|
+
if (configuration) {
|
|
116
|
+
baseOptions = configuration.baseOptions;
|
|
117
|
+
}
|
|
118
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
119
|
+
const localVarHeaderParameter = {};
|
|
120
|
+
const localVarQueryParameter = {};
|
|
121
|
+
// authentication session-oauth required
|
|
122
|
+
// oauth required
|
|
123
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
124
|
+
// authentication api-key required
|
|
125
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
126
|
+
if (project !== undefined) {
|
|
127
|
+
localVarQueryParameter['project'] = project;
|
|
128
|
+
}
|
|
129
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
130
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
132
|
+
return {
|
|
133
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
134
|
+
options: localVarRequestOptions,
|
|
135
|
+
};
|
|
136
|
+
}),
|
|
88
137
|
/**
|
|
89
138
|
* Export customers as a CSV file
|
|
90
139
|
* @summary Export customers
|
|
@@ -414,6 +463,24 @@ exports.CustomersApiAxiosParamCreator = CustomersApiAxiosParamCreator;
|
|
|
414
463
|
const CustomersApiFp = function (configuration) {
|
|
415
464
|
const localVarAxiosParamCreator = (0, exports.CustomersApiAxiosParamCreator)(configuration);
|
|
416
465
|
return {
|
|
466
|
+
/**
|
|
467
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
468
|
+
* @summary Create chat channel
|
|
469
|
+
* @param {string} project Project unique identifier
|
|
470
|
+
* @param {string} platformId The platform identifier
|
|
471
|
+
* @param {string} customerId The customer identifier
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
createCustomerChatChannel(project, platformId, customerId, options) {
|
|
476
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
477
|
+
var _a, _b, _c;
|
|
478
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createCustomerChatChannel(project, platformId, customerId, options);
|
|
479
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
480
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.createCustomerChatChannel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
481
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
482
|
+
});
|
|
483
|
+
},
|
|
417
484
|
/**
|
|
418
485
|
* Export customers as a CSV file
|
|
419
486
|
* @summary Export customers
|
|
@@ -530,6 +597,16 @@ exports.CustomersApiFp = CustomersApiFp;
|
|
|
530
597
|
const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
531
598
|
const localVarFp = (0, exports.CustomersApiFp)(configuration);
|
|
532
599
|
return {
|
|
600
|
+
/**
|
|
601
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
602
|
+
* @summary Create chat channel
|
|
603
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
createCustomerChatChannel(requestParameters, options) {
|
|
608
|
+
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
609
|
+
},
|
|
533
610
|
/**
|
|
534
611
|
* Export customers as a CSV file
|
|
535
612
|
* @summary Export customers
|
|
@@ -577,6 +654,16 @@ exports.CustomersApiFactory = CustomersApiFactory;
|
|
|
577
654
|
* CustomersApi - object-oriented interface
|
|
578
655
|
*/
|
|
579
656
|
class CustomersApi extends base_1.BaseAPI {
|
|
657
|
+
/**
|
|
658
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
659
|
+
* @summary Create chat channel
|
|
660
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
661
|
+
* @param {*} [options] Override http request option.
|
|
662
|
+
* @throws {RequiredError}
|
|
663
|
+
*/
|
|
664
|
+
createCustomerChatChannel(requestParameters, options) {
|
|
665
|
+
return (0, exports.CustomersApiFp)(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
666
|
+
}
|
|
580
667
|
/**
|
|
581
668
|
* Export customers as a CSV file
|
|
582
669
|
* @summary Export customers
|
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.47.0
|
|
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>;
|
|
@@ -306,6 +320,10 @@ export interface Customer {
|
|
|
306
320
|
'country': string | null;
|
|
307
321
|
'statistics': Statistics;
|
|
308
322
|
'shippingAddress'?: Address;
|
|
323
|
+
/**
|
|
324
|
+
* Reference to the chat channel resource
|
|
325
|
+
*/
|
|
326
|
+
'chatChannelRef'?: string | null;
|
|
309
327
|
}
|
|
310
328
|
export interface CustomersResponse {
|
|
311
329
|
'customers': Array<Customer>;
|
|
@@ -542,6 +560,7 @@ export interface Order {
|
|
|
542
560
|
'status'?: OrderStatus;
|
|
543
561
|
'approvalItemId'?: string | null;
|
|
544
562
|
'contactInformation': ContactInformation;
|
|
563
|
+
'paymentMethod'?: OrderPaymentMethod | null;
|
|
545
564
|
'shippingAddress': Address;
|
|
546
565
|
'billingAddress'?: Address;
|
|
547
566
|
/**
|
|
@@ -630,6 +649,9 @@ export interface OrderItem1RecipientCost {
|
|
|
630
649
|
'amount': string;
|
|
631
650
|
'currencyCode': string;
|
|
632
651
|
}
|
|
652
|
+
export interface OrderPaymentMethod {
|
|
653
|
+
'type': string;
|
|
654
|
+
}
|
|
633
655
|
export declare const OrderStatus: {
|
|
634
656
|
readonly New: "new";
|
|
635
657
|
readonly Paid: "paid";
|
|
@@ -1001,6 +1023,16 @@ export interface Variant {
|
|
|
1001
1023
|
* CustomersApi - axios parameter creator
|
|
1002
1024
|
*/
|
|
1003
1025
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1026
|
+
/**
|
|
1027
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1028
|
+
* @summary Create chat channel
|
|
1029
|
+
* @param {string} project Project unique identifier
|
|
1030
|
+
* @param {string} platformId The platform identifier
|
|
1031
|
+
* @param {string} customerId The customer identifier
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1004
1036
|
/**
|
|
1005
1037
|
* Export customers as a CSV file
|
|
1006
1038
|
* @summary Export customers
|
|
@@ -1081,6 +1113,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1081
1113
|
* CustomersApi - functional programming interface
|
|
1082
1114
|
*/
|
|
1083
1115
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
1116
|
+
/**
|
|
1117
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1118
|
+
* @summary Create chat channel
|
|
1119
|
+
* @param {string} project Project unique identifier
|
|
1120
|
+
* @param {string} platformId The platform identifier
|
|
1121
|
+
* @param {string} customerId The customer identifier
|
|
1122
|
+
* @param {*} [options] Override http request option.
|
|
1123
|
+
* @throws {RequiredError}
|
|
1124
|
+
*/
|
|
1125
|
+
createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1084
1126
|
/**
|
|
1085
1127
|
* Export customers as a CSV file
|
|
1086
1128
|
* @summary Export customers
|
|
@@ -1161,6 +1203,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1161
1203
|
* CustomersApi - factory interface
|
|
1162
1204
|
*/
|
|
1163
1205
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1206
|
+
/**
|
|
1207
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1208
|
+
* @summary Create chat channel
|
|
1209
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1210
|
+
* @param {*} [options] Override http request option.
|
|
1211
|
+
* @throws {RequiredError}
|
|
1212
|
+
*/
|
|
1213
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1164
1214
|
/**
|
|
1165
1215
|
* Export customers as a CSV file
|
|
1166
1216
|
* @summary Export customers
|
|
@@ -1194,6 +1244,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1194
1244
|
*/
|
|
1195
1245
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1196
1246
|
};
|
|
1247
|
+
/**
|
|
1248
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1249
|
+
*/
|
|
1250
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1251
|
+
/**
|
|
1252
|
+
* Project unique identifier
|
|
1253
|
+
*/
|
|
1254
|
+
readonly project: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* The platform identifier
|
|
1257
|
+
*/
|
|
1258
|
+
readonly platformId: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* The customer identifier
|
|
1261
|
+
*/
|
|
1262
|
+
readonly customerId: string;
|
|
1263
|
+
}
|
|
1197
1264
|
/**
|
|
1198
1265
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1199
1266
|
*/
|
|
@@ -1406,6 +1473,14 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1406
1473
|
* CustomersApi - object-oriented interface
|
|
1407
1474
|
*/
|
|
1408
1475
|
export declare class CustomersApi extends BaseAPI {
|
|
1476
|
+
/**
|
|
1477
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1478
|
+
* @summary Create chat channel
|
|
1479
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1409
1484
|
/**
|
|
1410
1485
|
* Export customers as a CSV file
|
|
1411
1486
|
* @summary Export customers
|
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.47.0
|
|
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
|
};
|
|
@@ -81,6 +86,50 @@ export const UpdateModerationItemRequestJudgementEnum = {
|
|
|
81
86
|
*/
|
|
82
87
|
export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
83
88
|
return {
|
|
89
|
+
/**
|
|
90
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
91
|
+
* @summary Create chat channel
|
|
92
|
+
* @param {string} project Project unique identifier
|
|
93
|
+
* @param {string} platformId The platform identifier
|
|
94
|
+
* @param {string} customerId The customer identifier
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
createCustomerChatChannel: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
99
|
+
// verify required parameter 'project' is not null or undefined
|
|
100
|
+
assertParamExists('createCustomerChatChannel', 'project', project);
|
|
101
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
102
|
+
assertParamExists('createCustomerChatChannel', 'platformId', platformId);
|
|
103
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
104
|
+
assertParamExists('createCustomerChatChannel', 'customerId', customerId);
|
|
105
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/chat-channel`
|
|
106
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
107
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
108
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
109
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
110
|
+
let baseOptions;
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
}
|
|
114
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
115
|
+
const localVarHeaderParameter = {};
|
|
116
|
+
const localVarQueryParameter = {};
|
|
117
|
+
// authentication session-oauth required
|
|
118
|
+
// oauth required
|
|
119
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
120
|
+
// authentication api-key required
|
|
121
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
122
|
+
if (project !== undefined) {
|
|
123
|
+
localVarQueryParameter['project'] = project;
|
|
124
|
+
}
|
|
125
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
126
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
127
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
128
|
+
return {
|
|
129
|
+
url: toPathString(localVarUrlObj),
|
|
130
|
+
options: localVarRequestOptions,
|
|
131
|
+
};
|
|
132
|
+
}),
|
|
84
133
|
/**
|
|
85
134
|
* Export customers as a CSV file
|
|
86
135
|
* @summary Export customers
|
|
@@ -409,6 +458,24 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
409
458
|
export const CustomersApiFp = function (configuration) {
|
|
410
459
|
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration);
|
|
411
460
|
return {
|
|
461
|
+
/**
|
|
462
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
463
|
+
* @summary Create chat channel
|
|
464
|
+
* @param {string} project Project unique identifier
|
|
465
|
+
* @param {string} platformId The platform identifier
|
|
466
|
+
* @param {string} customerId The customer identifier
|
|
467
|
+
* @param {*} [options] Override http request option.
|
|
468
|
+
* @throws {RequiredError}
|
|
469
|
+
*/
|
|
470
|
+
createCustomerChatChannel(project, platformId, customerId, options) {
|
|
471
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
472
|
+
var _a, _b, _c;
|
|
473
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createCustomerChatChannel(project, platformId, customerId, options);
|
|
474
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
475
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.createCustomerChatChannel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
476
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
477
|
+
});
|
|
478
|
+
},
|
|
412
479
|
/**
|
|
413
480
|
* Export customers as a CSV file
|
|
414
481
|
* @summary Export customers
|
|
@@ -524,6 +591,16 @@ export const CustomersApiFp = function (configuration) {
|
|
|
524
591
|
export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
525
592
|
const localVarFp = CustomersApiFp(configuration);
|
|
526
593
|
return {
|
|
594
|
+
/**
|
|
595
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
596
|
+
* @summary Create chat channel
|
|
597
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
598
|
+
* @param {*} [options] Override http request option.
|
|
599
|
+
* @throws {RequiredError}
|
|
600
|
+
*/
|
|
601
|
+
createCustomerChatChannel(requestParameters, options) {
|
|
602
|
+
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
603
|
+
},
|
|
527
604
|
/**
|
|
528
605
|
* Export customers as a CSV file
|
|
529
606
|
* @summary Export customers
|
|
@@ -570,6 +647,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
570
647
|
* CustomersApi - object-oriented interface
|
|
571
648
|
*/
|
|
572
649
|
export class CustomersApi extends BaseAPI {
|
|
650
|
+
/**
|
|
651
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
652
|
+
* @summary Create chat channel
|
|
653
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
createCustomerChatChannel(requestParameters, options) {
|
|
658
|
+
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
659
|
+
}
|
|
573
660
|
/**
|
|
574
661
|
* Export customers as a CSV file
|
|
575
662
|
* @summary Export customers
|
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)
|
package/docs/Customer.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**country** | **string** | | [default to undefined]
|
|
15
15
|
**statistics** | [**Statistics**](Statistics.md) | | [default to undefined]
|
|
16
16
|
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
17
|
+
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const instance: Customer = {
|
|
|
29
30
|
country,
|
|
30
31
|
statistics,
|
|
31
32
|
shippingAddress,
|
|
33
|
+
chatChannelRef,
|
|
32
34
|
};
|
|
33
35
|
```
|
|
34
36
|
|
package/docs/CustomersApi.md
CHANGED
|
@@ -4,11 +4,74 @@ All URIs are relative to *https://localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createCustomerChatChannel**](#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel|
|
|
7
8
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
8
9
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
9
10
|
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
10
11
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
11
12
|
|
|
13
|
+
# **createCustomerChatChannel**
|
|
14
|
+
> CreateOrderChatChannel200Response createCustomerChatChannel()
|
|
15
|
+
|
|
16
|
+
Create a chat channel for a platform customer if it doesn\'t exist
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
CustomersApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from '@teemill/platform';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new CustomersApi(configuration);
|
|
28
|
+
|
|
29
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
30
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
31
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.createCustomerChatChannel(
|
|
34
|
+
project,
|
|
35
|
+
platformId,
|
|
36
|
+
customerId
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
45
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
46
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**CreateOrderChatChannel200Response**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: Not defined
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Chat channel created | - |
|
|
67
|
+
|**400** | Failed validation | - |
|
|
68
|
+
|**401** | Not authorised to access this resource | - |
|
|
69
|
+
|**403** | Refuse to authorize | - |
|
|
70
|
+
|**404** | Resource not found | - |
|
|
71
|
+
|**500** | Unknown server error | - |
|
|
72
|
+
|
|
73
|
+
[[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)
|
|
74
|
+
|
|
12
75
|
# **exportCustomers**
|
|
13
76
|
> File exportCustomers()
|
|
14
77
|
|
package/docs/Order.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**status** | [**OrderStatus**](OrderStatus.md) | | [optional] [default to undefined]
|
|
11
11
|
**approvalItemId** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
13
|
+
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
13
14
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
14
15
|
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
15
16
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
@@ -42,6 +43,7 @@ const instance: Order = {
|
|
|
42
43
|
status,
|
|
43
44
|
approvalItemId,
|
|
44
45
|
contactInformation,
|
|
46
|
+
paymentMethod,
|
|
45
47
|
shippingAddress,
|
|
46
48
|
billingAddress,
|
|
47
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/index.ts
CHANGED