@teemill/platform 0.46.1 → 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 CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/platform@0.46.1
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.46.1 --save
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
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.46.1
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).
@@ -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>;
@@ -1069,6 +1073,58 @@ export interface Variant {
1069
1073
  */
1070
1074
  export const CustomersApiAxiosParamCreator = function (configuration?: Configuration) {
1071
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
+ },
1072
1128
  /**
1073
1129
  * Export customers as a CSV file
1074
1130
  * @summary Export customers
@@ -1468,6 +1524,21 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1468
1524
  export const CustomersApiFp = function(configuration?: Configuration) {
1469
1525
  const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration)
1470
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
+ },
1471
1542
  /**
1472
1543
  * Export customers as a CSV file
1473
1544
  * @summary Export customers
@@ -1572,6 +1643,16 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1572
1643
  export const CustomersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1573
1644
  const localVarFp = CustomersApiFp(configuration)
1574
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
+ },
1575
1656
  /**
1576
1657
  * Export customers as a CSV file
1577
1658
  * @summary Export customers
@@ -1615,6 +1696,26 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
1615
1696
  };
1616
1697
  };
1617
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
+
1618
1719
  /**
1619
1720
  * Request parameters for exportCustomers operation in CustomersApi.
1620
1721
  */
@@ -1874,6 +1975,17 @@ export interface CustomersApiListCustomersRequest {
1874
1975
  * CustomersApi - object-oriented interface
1875
1976
  */
1876
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
+
1877
1989
  /**
1878
1990
  * Export customers as a CSV file
1879
1991
  * @summary Export customers
package/base.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.46.1
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).
package/common.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.46.1
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).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Platform API
4
4
  * Manage Your podOS platform
5
5
  *
6
- * The version of the OpenAPI document: 0.46.1
6
+ * The version of the OpenAPI document: 0.47.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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.46.1
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).
@@ -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>;
@@ -1019,6 +1023,16 @@ export interface Variant {
1019
1023
  * CustomersApi - axios parameter creator
1020
1024
  */
1021
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>;
1022
1036
  /**
1023
1037
  * Export customers as a CSV file
1024
1038
  * @summary Export customers
@@ -1099,6 +1113,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1099
1113
  * CustomersApi - functional programming interface
1100
1114
  */
1101
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>>;
1102
1126
  /**
1103
1127
  * Export customers as a CSV file
1104
1128
  * @summary Export customers
@@ -1179,6 +1203,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1179
1203
  * CustomersApi - factory interface
1180
1204
  */
1181
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>;
1182
1214
  /**
1183
1215
  * Export customers as a CSV file
1184
1216
  * @summary Export customers
@@ -1212,6 +1244,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
1212
1244
  */
1213
1245
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
1214
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
+ }
1215
1264
  /**
1216
1265
  * Request parameters for exportCustomers operation in CustomersApi.
1217
1266
  */
@@ -1424,6 +1473,14 @@ export interface CustomersApiListCustomersRequest {
1424
1473
  * CustomersApi - object-oriented interface
1425
1474
  */
1426
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, {}>>;
1427
1484
  /**
1428
1485
  * Export customers as a CSV file
1429
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.46.1
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).
@@ -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
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
package/dist/base.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.46.1
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).
package/dist/common.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.46.1
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).
package/dist/common.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.46.1
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).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.46.1
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).
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.46.1
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).
@@ -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>;
@@ -1019,6 +1023,16 @@ export interface Variant {
1019
1023
  * CustomersApi - axios parameter creator
1020
1024
  */
1021
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>;
1022
1036
  /**
1023
1037
  * Export customers as a CSV file
1024
1038
  * @summary Export customers
@@ -1099,6 +1113,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1099
1113
  * CustomersApi - functional programming interface
1100
1114
  */
1101
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>>;
1102
1126
  /**
1103
1127
  * Export customers as a CSV file
1104
1128
  * @summary Export customers
@@ -1179,6 +1203,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1179
1203
  * CustomersApi - factory interface
1180
1204
  */
1181
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>;
1182
1214
  /**
1183
1215
  * Export customers as a CSV file
1184
1216
  * @summary Export customers
@@ -1212,6 +1244,23 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
1212
1244
  */
1213
1245
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
1214
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
+ }
1215
1264
  /**
1216
1265
  * Request parameters for exportCustomers operation in CustomersApi.
1217
1266
  */
@@ -1424,6 +1473,14 @@ export interface CustomersApiListCustomersRequest {
1424
1473
  * CustomersApi - object-oriented interface
1425
1474
  */
1426
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, {}>>;
1427
1484
  /**
1428
1485
  * Export customers as a CSV file
1429
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.46.1
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).
@@ -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
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
package/dist/esm/base.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.46.1
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).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.46.1
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).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
@@ -3,7 +3,7 @@
3
3
  * Platform API
4
4
  * Manage Your podOS platform
5
5
  *
6
- * The version of the OpenAPI document: 0.46.1
6
+ * The version of the OpenAPI document: 0.47.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.46.1
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).
package/dist/esm/index.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.46.1
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).
package/dist/index.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.46.1
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).
package/dist/index.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.46.1
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).
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
 
@@ -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/index.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.46.1
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).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.46.1",
3
+ "version": "0.47.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {