@teemill/platform 0.46.1 → 0.47.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 +3 -2
- package/api.ts +116 -3
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +61 -3
- package/dist/api.js +83 -1
- 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 +61 -3
- package/dist/esm/api.js +83 -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/Customer.md +2 -0
- package/docs/CustomersApi.md +63 -0
- package/docs/Fulfiller.md +4 -2
- 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.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.47.1 --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
|
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.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -344,6 +344,10 @@ export interface Customer {
|
|
|
344
344
|
'country': string | null;
|
|
345
345
|
'statistics': Statistics;
|
|
346
346
|
'shippingAddress'?: Address;
|
|
347
|
+
/**
|
|
348
|
+
* Reference to the chat channel resource
|
|
349
|
+
*/
|
|
350
|
+
'chatChannelRef'?: string | null;
|
|
347
351
|
}
|
|
348
352
|
export interface CustomersResponse {
|
|
349
353
|
'customers': Array<Customer>;
|
|
@@ -466,8 +470,9 @@ export interface Fulfiller {
|
|
|
466
470
|
/**
|
|
467
471
|
* Unique object identifier
|
|
468
472
|
*/
|
|
469
|
-
'id'
|
|
470
|
-
'location'
|
|
473
|
+
'id': string;
|
|
474
|
+
'location': FulfillerLocation;
|
|
475
|
+
'canFulfillImmediately': boolean | null;
|
|
471
476
|
}
|
|
472
477
|
export interface FulfillerLocation {
|
|
473
478
|
'city'?: string | null;
|
|
@@ -1069,6 +1074,58 @@ export interface Variant {
|
|
|
1069
1074
|
*/
|
|
1070
1075
|
export const CustomersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1071
1076
|
return {
|
|
1077
|
+
/**
|
|
1078
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1079
|
+
* @summary Create chat channel
|
|
1080
|
+
* @param {string} project Project unique identifier
|
|
1081
|
+
* @param {string} platformId The platform identifier
|
|
1082
|
+
* @param {string} customerId The customer identifier
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
createCustomerChatChannel: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1087
|
+
// verify required parameter 'project' is not null or undefined
|
|
1088
|
+
assertParamExists('createCustomerChatChannel', 'project', project)
|
|
1089
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1090
|
+
assertParamExists('createCustomerChatChannel', 'platformId', platformId)
|
|
1091
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1092
|
+
assertParamExists('createCustomerChatChannel', 'customerId', customerId)
|
|
1093
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/chat-channel`
|
|
1094
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1095
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1096
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1097
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1098
|
+
let baseOptions;
|
|
1099
|
+
if (configuration) {
|
|
1100
|
+
baseOptions = configuration.baseOptions;
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1104
|
+
const localVarHeaderParameter = {} as any;
|
|
1105
|
+
const localVarQueryParameter = {} as any;
|
|
1106
|
+
|
|
1107
|
+
// authentication session-oauth required
|
|
1108
|
+
// oauth required
|
|
1109
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1110
|
+
|
|
1111
|
+
// authentication api-key required
|
|
1112
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1113
|
+
|
|
1114
|
+
if (project !== undefined) {
|
|
1115
|
+
localVarQueryParameter['project'] = project;
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1121
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1122
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1123
|
+
|
|
1124
|
+
return {
|
|
1125
|
+
url: toPathString(localVarUrlObj),
|
|
1126
|
+
options: localVarRequestOptions,
|
|
1127
|
+
};
|
|
1128
|
+
},
|
|
1072
1129
|
/**
|
|
1073
1130
|
* Export customers as a CSV file
|
|
1074
1131
|
* @summary Export customers
|
|
@@ -1468,6 +1525,21 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1468
1525
|
export const CustomersApiFp = function(configuration?: Configuration) {
|
|
1469
1526
|
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration)
|
|
1470
1527
|
return {
|
|
1528
|
+
/**
|
|
1529
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1530
|
+
* @summary Create chat channel
|
|
1531
|
+
* @param {string} project Project unique identifier
|
|
1532
|
+
* @param {string} platformId The platform identifier
|
|
1533
|
+
* @param {string} customerId The customer identifier
|
|
1534
|
+
* @param {*} [options] Override http request option.
|
|
1535
|
+
* @throws {RequiredError}
|
|
1536
|
+
*/
|
|
1537
|
+
async createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
1538
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomerChatChannel(project, platformId, customerId, options);
|
|
1539
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1540
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.createCustomerChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
1541
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1542
|
+
},
|
|
1471
1543
|
/**
|
|
1472
1544
|
* Export customers as a CSV file
|
|
1473
1545
|
* @summary Export customers
|
|
@@ -1572,6 +1644,16 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1572
1644
|
export const CustomersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1573
1645
|
const localVarFp = CustomersApiFp(configuration)
|
|
1574
1646
|
return {
|
|
1647
|
+
/**
|
|
1648
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1649
|
+
* @summary Create chat channel
|
|
1650
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1651
|
+
* @param {*} [options] Override http request option.
|
|
1652
|
+
* @throws {RequiredError}
|
|
1653
|
+
*/
|
|
1654
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
1655
|
+
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1656
|
+
},
|
|
1575
1657
|
/**
|
|
1576
1658
|
* Export customers as a CSV file
|
|
1577
1659
|
* @summary Export customers
|
|
@@ -1615,6 +1697,26 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1615
1697
|
};
|
|
1616
1698
|
};
|
|
1617
1699
|
|
|
1700
|
+
/**
|
|
1701
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1702
|
+
*/
|
|
1703
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1704
|
+
/**
|
|
1705
|
+
* Project unique identifier
|
|
1706
|
+
*/
|
|
1707
|
+
readonly project: string
|
|
1708
|
+
|
|
1709
|
+
/**
|
|
1710
|
+
* The platform identifier
|
|
1711
|
+
*/
|
|
1712
|
+
readonly platformId: string
|
|
1713
|
+
|
|
1714
|
+
/**
|
|
1715
|
+
* The customer identifier
|
|
1716
|
+
*/
|
|
1717
|
+
readonly customerId: string
|
|
1718
|
+
}
|
|
1719
|
+
|
|
1618
1720
|
/**
|
|
1619
1721
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1620
1722
|
*/
|
|
@@ -1874,6 +1976,17 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1874
1976
|
* CustomersApi - object-oriented interface
|
|
1875
1977
|
*/
|
|
1876
1978
|
export class CustomersApi extends BaseAPI {
|
|
1979
|
+
/**
|
|
1980
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1981
|
+
* @summary Create chat channel
|
|
1982
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1983
|
+
* @param {*} [options] Override http request option.
|
|
1984
|
+
* @throws {RequiredError}
|
|
1985
|
+
*/
|
|
1986
|
+
public createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
1987
|
+
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
1988
|
+
}
|
|
1989
|
+
|
|
1877
1990
|
/**
|
|
1878
1991
|
* Export customers as a CSV file
|
|
1879
1992
|
* @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.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -320,6 +320,10 @@ export interface Customer {
|
|
|
320
320
|
'country': string | null;
|
|
321
321
|
'statistics': Statistics;
|
|
322
322
|
'shippingAddress'?: Address;
|
|
323
|
+
/**
|
|
324
|
+
* Reference to the chat channel resource
|
|
325
|
+
*/
|
|
326
|
+
'chatChannelRef'?: string | null;
|
|
323
327
|
}
|
|
324
328
|
export interface CustomersResponse {
|
|
325
329
|
'customers': Array<Customer>;
|
|
@@ -437,8 +441,9 @@ export interface Fulfiller {
|
|
|
437
441
|
/**
|
|
438
442
|
* Unique object identifier
|
|
439
443
|
*/
|
|
440
|
-
'id'
|
|
441
|
-
'location'
|
|
444
|
+
'id': string;
|
|
445
|
+
'location': FulfillerLocation;
|
|
446
|
+
'canFulfillImmediately': boolean | null;
|
|
442
447
|
}
|
|
443
448
|
export interface FulfillerLocation {
|
|
444
449
|
'city'?: string | null;
|
|
@@ -1019,6 +1024,16 @@ export interface Variant {
|
|
|
1019
1024
|
* CustomersApi - axios parameter creator
|
|
1020
1025
|
*/
|
|
1021
1026
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1027
|
+
/**
|
|
1028
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1029
|
+
* @summary Create chat channel
|
|
1030
|
+
* @param {string} project Project unique identifier
|
|
1031
|
+
* @param {string} platformId The platform identifier
|
|
1032
|
+
* @param {string} customerId The customer identifier
|
|
1033
|
+
* @param {*} [options] Override http request option.
|
|
1034
|
+
* @throws {RequiredError}
|
|
1035
|
+
*/
|
|
1036
|
+
createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1022
1037
|
/**
|
|
1023
1038
|
* Export customers as a CSV file
|
|
1024
1039
|
* @summary Export customers
|
|
@@ -1099,6 +1114,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1099
1114
|
* CustomersApi - functional programming interface
|
|
1100
1115
|
*/
|
|
1101
1116
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
1117
|
+
/**
|
|
1118
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1119
|
+
* @summary Create chat channel
|
|
1120
|
+
* @param {string} project Project unique identifier
|
|
1121
|
+
* @param {string} platformId The platform identifier
|
|
1122
|
+
* @param {string} customerId The customer identifier
|
|
1123
|
+
* @param {*} [options] Override http request option.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
*/
|
|
1126
|
+
createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1102
1127
|
/**
|
|
1103
1128
|
* Export customers as a CSV file
|
|
1104
1129
|
* @summary Export customers
|
|
@@ -1179,6 +1204,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1179
1204
|
* CustomersApi - factory interface
|
|
1180
1205
|
*/
|
|
1181
1206
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1207
|
+
/**
|
|
1208
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1209
|
+
* @summary Create chat channel
|
|
1210
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
*/
|
|
1214
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1182
1215
|
/**
|
|
1183
1216
|
* Export customers as a CSV file
|
|
1184
1217
|
* @summary Export customers
|
|
@@ -1212,6 +1245,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1212
1245
|
*/
|
|
1213
1246
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1214
1247
|
};
|
|
1248
|
+
/**
|
|
1249
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1250
|
+
*/
|
|
1251
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1252
|
+
/**
|
|
1253
|
+
* Project unique identifier
|
|
1254
|
+
*/
|
|
1255
|
+
readonly project: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* The platform identifier
|
|
1258
|
+
*/
|
|
1259
|
+
readonly platformId: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The customer identifier
|
|
1262
|
+
*/
|
|
1263
|
+
readonly customerId: string;
|
|
1264
|
+
}
|
|
1215
1265
|
/**
|
|
1216
1266
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1217
1267
|
*/
|
|
@@ -1424,6 +1474,14 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1424
1474
|
* CustomersApi - object-oriented interface
|
|
1425
1475
|
*/
|
|
1426
1476
|
export declare class CustomersApi extends BaseAPI {
|
|
1477
|
+
/**
|
|
1478
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1479
|
+
* @summary Create chat channel
|
|
1480
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @throws {RequiredError}
|
|
1483
|
+
*/
|
|
1484
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1427
1485
|
/**
|
|
1428
1486
|
* Export customers as a CSV file
|
|
1429
1487
|
* @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.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -90,6 +90,50 @@ exports.UpdateModerationItemRequestJudgementEnum = {
|
|
|
90
90
|
*/
|
|
91
91
|
const CustomersApiAxiosParamCreator = function (configuration) {
|
|
92
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
|
+
}),
|
|
93
137
|
/**
|
|
94
138
|
* Export customers as a CSV file
|
|
95
139
|
* @summary Export customers
|
|
@@ -419,6 +463,24 @@ exports.CustomersApiAxiosParamCreator = CustomersApiAxiosParamCreator;
|
|
|
419
463
|
const CustomersApiFp = function (configuration) {
|
|
420
464
|
const localVarAxiosParamCreator = (0, exports.CustomersApiAxiosParamCreator)(configuration);
|
|
421
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
|
+
},
|
|
422
484
|
/**
|
|
423
485
|
* Export customers as a CSV file
|
|
424
486
|
* @summary Export customers
|
|
@@ -535,6 +597,16 @@ exports.CustomersApiFp = CustomersApiFp;
|
|
|
535
597
|
const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
536
598
|
const localVarFp = (0, exports.CustomersApiFp)(configuration);
|
|
537
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
|
+
},
|
|
538
610
|
/**
|
|
539
611
|
* Export customers as a CSV file
|
|
540
612
|
* @summary Export customers
|
|
@@ -582,6 +654,16 @@ exports.CustomersApiFactory = CustomersApiFactory;
|
|
|
582
654
|
* CustomersApi - object-oriented interface
|
|
583
655
|
*/
|
|
584
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
|
+
}
|
|
585
667
|
/**
|
|
586
668
|
* Export customers as a CSV file
|
|
587
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.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -320,6 +320,10 @@ export interface Customer {
|
|
|
320
320
|
'country': string | null;
|
|
321
321
|
'statistics': Statistics;
|
|
322
322
|
'shippingAddress'?: Address;
|
|
323
|
+
/**
|
|
324
|
+
* Reference to the chat channel resource
|
|
325
|
+
*/
|
|
326
|
+
'chatChannelRef'?: string | null;
|
|
323
327
|
}
|
|
324
328
|
export interface CustomersResponse {
|
|
325
329
|
'customers': Array<Customer>;
|
|
@@ -437,8 +441,9 @@ export interface Fulfiller {
|
|
|
437
441
|
/**
|
|
438
442
|
* Unique object identifier
|
|
439
443
|
*/
|
|
440
|
-
'id'
|
|
441
|
-
'location'
|
|
444
|
+
'id': string;
|
|
445
|
+
'location': FulfillerLocation;
|
|
446
|
+
'canFulfillImmediately': boolean | null;
|
|
442
447
|
}
|
|
443
448
|
export interface FulfillerLocation {
|
|
444
449
|
'city'?: string | null;
|
|
@@ -1019,6 +1024,16 @@ export interface Variant {
|
|
|
1019
1024
|
* CustomersApi - axios parameter creator
|
|
1020
1025
|
*/
|
|
1021
1026
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1027
|
+
/**
|
|
1028
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1029
|
+
* @summary Create chat channel
|
|
1030
|
+
* @param {string} project Project unique identifier
|
|
1031
|
+
* @param {string} platformId The platform identifier
|
|
1032
|
+
* @param {string} customerId The customer identifier
|
|
1033
|
+
* @param {*} [options] Override http request option.
|
|
1034
|
+
* @throws {RequiredError}
|
|
1035
|
+
*/
|
|
1036
|
+
createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1022
1037
|
/**
|
|
1023
1038
|
* Export customers as a CSV file
|
|
1024
1039
|
* @summary Export customers
|
|
@@ -1099,6 +1114,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1099
1114
|
* CustomersApi - functional programming interface
|
|
1100
1115
|
*/
|
|
1101
1116
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
1117
|
+
/**
|
|
1118
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1119
|
+
* @summary Create chat channel
|
|
1120
|
+
* @param {string} project Project unique identifier
|
|
1121
|
+
* @param {string} platformId The platform identifier
|
|
1122
|
+
* @param {string} customerId The customer identifier
|
|
1123
|
+
* @param {*} [options] Override http request option.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
*/
|
|
1126
|
+
createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1102
1127
|
/**
|
|
1103
1128
|
* Export customers as a CSV file
|
|
1104
1129
|
* @summary Export customers
|
|
@@ -1179,6 +1204,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1179
1204
|
* CustomersApi - factory interface
|
|
1180
1205
|
*/
|
|
1181
1206
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1207
|
+
/**
|
|
1208
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1209
|
+
* @summary Create chat channel
|
|
1210
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
*/
|
|
1214
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1182
1215
|
/**
|
|
1183
1216
|
* Export customers as a CSV file
|
|
1184
1217
|
* @summary Export customers
|
|
@@ -1212,6 +1245,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1212
1245
|
*/
|
|
1213
1246
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1214
1247
|
};
|
|
1248
|
+
/**
|
|
1249
|
+
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
1250
|
+
*/
|
|
1251
|
+
export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
1252
|
+
/**
|
|
1253
|
+
* Project unique identifier
|
|
1254
|
+
*/
|
|
1255
|
+
readonly project: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* The platform identifier
|
|
1258
|
+
*/
|
|
1259
|
+
readonly platformId: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The customer identifier
|
|
1262
|
+
*/
|
|
1263
|
+
readonly customerId: string;
|
|
1264
|
+
}
|
|
1215
1265
|
/**
|
|
1216
1266
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1217
1267
|
*/
|
|
@@ -1424,6 +1474,14 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1424
1474
|
* CustomersApi - object-oriented interface
|
|
1425
1475
|
*/
|
|
1426
1476
|
export declare class CustomersApi extends BaseAPI {
|
|
1477
|
+
/**
|
|
1478
|
+
* Create a chat channel for a platform customer if it doesn\'t exist
|
|
1479
|
+
* @summary Create chat channel
|
|
1480
|
+
* @param {CustomersApiCreateCustomerChatChannelRequest} requestParameters Request parameters.
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @throws {RequiredError}
|
|
1483
|
+
*/
|
|
1484
|
+
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1427
1485
|
/**
|
|
1428
1486
|
* Export customers as a CSV file
|
|
1429
1487
|
* @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.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -86,6 +86,50 @@ export const UpdateModerationItemRequestJudgementEnum = {
|
|
|
86
86
|
*/
|
|
87
87
|
export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
88
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
|
+
}),
|
|
89
133
|
/**
|
|
90
134
|
* Export customers as a CSV file
|
|
91
135
|
* @summary Export customers
|
|
@@ -414,6 +458,24 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
414
458
|
export const CustomersApiFp = function (configuration) {
|
|
415
459
|
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration);
|
|
416
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
|
+
},
|
|
417
479
|
/**
|
|
418
480
|
* Export customers as a CSV file
|
|
419
481
|
* @summary Export customers
|
|
@@ -529,6 +591,16 @@ export const CustomersApiFp = function (configuration) {
|
|
|
529
591
|
export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
530
592
|
const localVarFp = CustomersApiFp(configuration);
|
|
531
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
|
+
},
|
|
532
604
|
/**
|
|
533
605
|
* Export customers as a CSV file
|
|
534
606
|
* @summary Export customers
|
|
@@ -575,6 +647,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
575
647
|
* CustomersApi - object-oriented interface
|
|
576
648
|
*/
|
|
577
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
|
+
}
|
|
578
660
|
/**
|
|
579
661
|
* Export customers as a CSV file
|
|
580
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/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/Fulfiller.md
CHANGED
|
@@ -6,8 +6,9 @@ The fulfiller that will be processing this order.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | Unique object identifier | [
|
|
10
|
-
**location** | [**FulfillerLocation**](FulfillerLocation.md) | | [
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**location** | [**FulfillerLocation**](FulfillerLocation.md) | | [default to undefined]
|
|
11
|
+
**canFulfillImmediately** | **boolean** | | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -17,6 +18,7 @@ import { Fulfiller } from '@teemill/platform';
|
|
|
17
18
|
const instance: Fulfiller = {
|
|
18
19
|
id,
|
|
19
20
|
location,
|
|
21
|
+
canFulfillImmediately,
|
|
20
22
|
};
|
|
21
23
|
```
|
|
22
24
|
|
package/index.ts
CHANGED