@teemill/platform 0.22.3 → 0.24.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/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.22.3
7
+ * The version of the OpenAPI document: 0.24.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -427,12 +427,56 @@ export const ListCustomersSortByEnum = {
427
427
  */
428
428
  export const EnquiriesApiAxiosParamCreator = function (configuration) {
429
429
  return {
430
+ /**
431
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
432
+ * @summary Create chat channel
433
+ * @param {string} project Project unique identifier
434
+ * @param {string} platformId The platform identifier
435
+ * @param {string} enquiryId The enquiry identifier
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ */
439
+ createChatChannel: (project_1, platformId_1, enquiryId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, enquiryId_1, ...args_1], void 0, function* (project, platformId, enquiryId, options = {}) {
440
+ // verify required parameter 'project' is not null or undefined
441
+ assertParamExists('createChatChannel', 'project', project);
442
+ // verify required parameter 'platformId' is not null or undefined
443
+ assertParamExists('createChatChannel', 'platformId', platformId);
444
+ // verify required parameter 'enquiryId' is not null or undefined
445
+ assertParamExists('createChatChannel', 'enquiryId', enquiryId);
446
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel`
447
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
448
+ .replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
449
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
450
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
451
+ let baseOptions;
452
+ if (configuration) {
453
+ baseOptions = configuration.baseOptions;
454
+ }
455
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
456
+ const localVarHeaderParameter = {};
457
+ const localVarQueryParameter = {};
458
+ // authentication session-oauth required
459
+ // oauth required
460
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
461
+ // authentication api-key required
462
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
463
+ if (project !== undefined) {
464
+ localVarQueryParameter['project'] = project;
465
+ }
466
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
467
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
468
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
469
+ return {
470
+ url: toPathString(localVarUrlObj),
471
+ options: localVarRequestOptions,
472
+ };
473
+ }),
430
474
  /**
431
475
  * Get a customer enquiry
432
476
  * @summary Get customer enquiry
433
477
  * @param {string} project Project unique identifier
434
478
  * @param {string} platformId The platform identifier
435
- * @param {string} enquiryId
479
+ * @param {string} enquiryId The enquiry identifier
436
480
  * @param {*} [options] Override http request option.
437
481
  * @throws {RequiredError}
438
482
  */
@@ -540,7 +584,7 @@ export const EnquiriesApiAxiosParamCreator = function (configuration) {
540
584
  * @summary List customer enquiry Logs
541
585
  * @param {string} project Project unique identifier
542
586
  * @param {string} platformId The platform identifier
543
- * @param {string} enquiryId
587
+ * @param {string} enquiryId The enquiry identifier
544
588
  * @param {*} [options] Override http request option.
545
589
  * @throws {RequiredError}
546
590
  */
@@ -588,12 +632,30 @@ export const EnquiriesApiAxiosParamCreator = function (configuration) {
588
632
  export const EnquiriesApiFp = function (configuration) {
589
633
  const localVarAxiosParamCreator = EnquiriesApiAxiosParamCreator(configuration);
590
634
  return {
635
+ /**
636
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
637
+ * @summary Create chat channel
638
+ * @param {string} project Project unique identifier
639
+ * @param {string} platformId The platform identifier
640
+ * @param {string} enquiryId The enquiry identifier
641
+ * @param {*} [options] Override http request option.
642
+ * @throws {RequiredError}
643
+ */
644
+ createChatChannel(project, platformId, enquiryId, options) {
645
+ return __awaiter(this, void 0, void 0, function* () {
646
+ var _a, _b, _c;
647
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createChatChannel(project, platformId, enquiryId, options);
648
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
649
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EnquiriesApi.createChatChannel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
650
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
651
+ });
652
+ },
591
653
  /**
592
654
  * Get a customer enquiry
593
655
  * @summary Get customer enquiry
594
656
  * @param {string} project Project unique identifier
595
657
  * @param {string} platformId The platform identifier
596
- * @param {string} enquiryId
658
+ * @param {string} enquiryId The enquiry identifier
597
659
  * @param {*} [options] Override http request option.
598
660
  * @throws {RequiredError}
599
661
  */
@@ -633,7 +695,7 @@ export const EnquiriesApiFp = function (configuration) {
633
695
  * @summary List customer enquiry Logs
634
696
  * @param {string} project Project unique identifier
635
697
  * @param {string} platformId The platform identifier
636
- * @param {string} enquiryId
698
+ * @param {string} enquiryId The enquiry identifier
637
699
  * @param {*} [options] Override http request option.
638
700
  * @throws {RequiredError}
639
701
  */
@@ -655,6 +717,16 @@ export const EnquiriesApiFp = function (configuration) {
655
717
  export const EnquiriesApiFactory = function (configuration, basePath, axios) {
656
718
  const localVarFp = EnquiriesApiFp(configuration);
657
719
  return {
720
+ /**
721
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
722
+ * @summary Create chat channel
723
+ * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
724
+ * @param {*} [options] Override http request option.
725
+ * @throws {RequiredError}
726
+ */
727
+ createChatChannel(requestParameters, options) {
728
+ return localVarFp.createChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
729
+ },
658
730
  /**
659
731
  * Get a customer enquiry
660
732
  * @summary Get customer enquiry
@@ -694,6 +766,17 @@ export const EnquiriesApiFactory = function (configuration, basePath, axios) {
694
766
  * @extends {BaseAPI}
695
767
  */
696
768
  export class EnquiriesApi extends BaseAPI {
769
+ /**
770
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
771
+ * @summary Create chat channel
772
+ * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
773
+ * @param {*} [options] Override http request option.
774
+ * @throws {RequiredError}
775
+ * @memberof EnquiriesApi
776
+ */
777
+ createChatChannel(requestParameters, options) {
778
+ return EnquiriesApiFp(this.configuration).createChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
779
+ }
697
780
  /**
698
781
  * Get a customer enquiry
699
782
  * @summary Get customer enquiry
@@ -880,6 +963,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
880
963
  options: localVarRequestOptions,
881
964
  };
882
965
  }),
966
+ /**
967
+ * Get an order receipt for a platform by a given order ID.
968
+ * @summary Get order receipt
969
+ * @param {string} project Project unique identifier
970
+ * @param {string} platformId The platform identifier
971
+ * @param {string} orderId The order identifier
972
+ * @param {*} [options] Override http request option.
973
+ * @throws {RequiredError}
974
+ */
975
+ getOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
976
+ // verify required parameter 'project' is not null or undefined
977
+ assertParamExists('getOrderReceipt', 'project', project);
978
+ // verify required parameter 'platformId' is not null or undefined
979
+ assertParamExists('getOrderReceipt', 'platformId', platformId);
980
+ // verify required parameter 'orderId' is not null or undefined
981
+ assertParamExists('getOrderReceipt', 'orderId', orderId);
982
+ const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt`
983
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
984
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
985
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
986
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
987
+ let baseOptions;
988
+ if (configuration) {
989
+ baseOptions = configuration.baseOptions;
990
+ }
991
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
992
+ const localVarHeaderParameter = {};
993
+ const localVarQueryParameter = {};
994
+ // authentication session-oauth required
995
+ // oauth required
996
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
997
+ // authentication api-key required
998
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
999
+ if (project !== undefined) {
1000
+ localVarQueryParameter['project'] = project;
1001
+ }
1002
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1003
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1004
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1005
+ return {
1006
+ url: toPathString(localVarUrlObj),
1007
+ options: localVarRequestOptions,
1008
+ };
1009
+ }),
883
1010
  /**
884
1011
  * List available fulfillers for a given fulfillment
885
1012
  * @summary List available fulfillers
@@ -1036,6 +1163,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
1036
1163
  options: localVarRequestOptions,
1037
1164
  };
1038
1165
  }),
1166
+ /**
1167
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
1168
+ * @summary Send order receipt
1169
+ * @param {string} project Project unique identifier
1170
+ * @param {string} platformId The platform identifier
1171
+ * @param {string} orderId The order identifier
1172
+ * @param {*} [options] Override http request option.
1173
+ * @throws {RequiredError}
1174
+ */
1175
+ sendOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
1176
+ // verify required parameter 'project' is not null or undefined
1177
+ assertParamExists('sendOrderReceipt', 'project', project);
1178
+ // verify required parameter 'platformId' is not null or undefined
1179
+ assertParamExists('sendOrderReceipt', 'platformId', platformId);
1180
+ // verify required parameter 'orderId' is not null or undefined
1181
+ assertParamExists('sendOrderReceipt', 'orderId', orderId);
1182
+ const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt/send`
1183
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
1184
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
1185
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1186
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1187
+ let baseOptions;
1188
+ if (configuration) {
1189
+ baseOptions = configuration.baseOptions;
1190
+ }
1191
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1192
+ const localVarHeaderParameter = {};
1193
+ const localVarQueryParameter = {};
1194
+ // authentication session-oauth required
1195
+ // oauth required
1196
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1197
+ // authentication api-key required
1198
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1199
+ if (project !== undefined) {
1200
+ localVarQueryParameter['project'] = project;
1201
+ }
1202
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1203
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1204
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1205
+ return {
1206
+ url: toPathString(localVarUrlObj),
1207
+ options: localVarRequestOptions,
1208
+ };
1209
+ }),
1039
1210
  /**
1040
1211
  * Update a fulfillment that belongs to an order placed through the platform
1041
1212
  * @summary Update fulfillment
@@ -1150,6 +1321,24 @@ export const OrdersApiFp = function (configuration) {
1150
1321
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1151
1322
  });
1152
1323
  },
1324
+ /**
1325
+ * Get an order receipt for a platform by a given order ID.
1326
+ * @summary Get order receipt
1327
+ * @param {string} project Project unique identifier
1328
+ * @param {string} platformId The platform identifier
1329
+ * @param {string} orderId The order identifier
1330
+ * @param {*} [options] Override http request option.
1331
+ * @throws {RequiredError}
1332
+ */
1333
+ getOrderReceipt(project, platformId, orderId, options) {
1334
+ return __awaiter(this, void 0, void 0, function* () {
1335
+ var _a, _b, _c;
1336
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderReceipt(project, platformId, orderId, options);
1337
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1338
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.getOrderReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1339
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1340
+ });
1341
+ },
1153
1342
  /**
1154
1343
  * List available fulfillers for a given fulfillment
1155
1344
  * @summary List available fulfillers
@@ -1209,6 +1398,24 @@ export const OrdersApiFp = function (configuration) {
1209
1398
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1210
1399
  });
1211
1400
  },
1401
+ /**
1402
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
1403
+ * @summary Send order receipt
1404
+ * @param {string} project Project unique identifier
1405
+ * @param {string} platformId The platform identifier
1406
+ * @param {string} orderId The order identifier
1407
+ * @param {*} [options] Override http request option.
1408
+ * @throws {RequiredError}
1409
+ */
1410
+ sendOrderReceipt(project, platformId, orderId, options) {
1411
+ return __awaiter(this, void 0, void 0, function* () {
1412
+ var _a, _b, _c;
1413
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.sendOrderReceipt(project, platformId, orderId, options);
1414
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1415
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.sendOrderReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1416
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1417
+ });
1418
+ },
1212
1419
  /**
1213
1420
  * Update a fulfillment that belongs to an order placed through the platform
1214
1421
  * @summary Update fulfillment
@@ -1267,6 +1474,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
1267
1474
  getOrder(requestParameters, options) {
1268
1475
  return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
1269
1476
  },
1477
+ /**
1478
+ * Get an order receipt for a platform by a given order ID.
1479
+ * @summary Get order receipt
1480
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
1481
+ * @param {*} [options] Override http request option.
1482
+ * @throws {RequiredError}
1483
+ */
1484
+ getOrderReceipt(requestParameters, options) {
1485
+ return localVarFp.getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
1486
+ },
1270
1487
  /**
1271
1488
  * List available fulfillers for a given fulfillment
1272
1489
  * @summary List available fulfillers
@@ -1297,6 +1514,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
1297
1514
  retryPlatformPayment(requestParameters, options) {
1298
1515
  return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
1299
1516
  },
1517
+ /**
1518
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
1519
+ * @summary Send order receipt
1520
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
1521
+ * @param {*} [options] Override http request option.
1522
+ * @throws {RequiredError}
1523
+ */
1524
+ sendOrderReceipt(requestParameters, options) {
1525
+ return localVarFp.sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
1526
+ },
1300
1527
  /**
1301
1528
  * Update a fulfillment that belongs to an order placed through the platform
1302
1529
  * @summary Update fulfillment
@@ -1349,6 +1576,17 @@ export class OrdersApi extends BaseAPI {
1349
1576
  getOrder(requestParameters, options) {
1350
1577
  return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
1351
1578
  }
1579
+ /**
1580
+ * Get an order receipt for a platform by a given order ID.
1581
+ * @summary Get order receipt
1582
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
1583
+ * @param {*} [options] Override http request option.
1584
+ * @throws {RequiredError}
1585
+ * @memberof OrdersApi
1586
+ */
1587
+ getOrderReceipt(requestParameters, options) {
1588
+ return OrdersApiFp(this.configuration).getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
1589
+ }
1352
1590
  /**
1353
1591
  * List available fulfillers for a given fulfillment
1354
1592
  * @summary List available fulfillers
@@ -1382,6 +1620,17 @@ export class OrdersApi extends BaseAPI {
1382
1620
  retryPlatformPayment(requestParameters, options) {
1383
1621
  return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
1384
1622
  }
1623
+ /**
1624
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
1625
+ * @summary Send order receipt
1626
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
1627
+ * @param {*} [options] Override http request option.
1628
+ * @throws {RequiredError}
1629
+ * @memberof OrdersApi
1630
+ */
1631
+ sendOrderReceipt(requestParameters, options) {
1632
+ return OrdersApiFp(this.configuration).sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
1633
+ }
1385
1634
  /**
1386
1635
  * Update a fulfillment that belongs to an order placed through the platform
1387
1636
  * @summary Update fulfillment
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.22.3
5
+ * The version of the OpenAPI document: 0.24.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.22.3
7
+ * The version of the OpenAPI document: 0.24.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.22.3
5
+ * The version of the OpenAPI document: 0.24.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.22.3
7
+ * The version of the OpenAPI document: 0.24.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.22.3
5
+ * The version of the OpenAPI document: 0.24.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.22.3
7
+ * The version of the OpenAPI document: 0.24.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.22.3
5
+ * The version of the OpenAPI document: 0.24.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.22.3
7
+ * The version of the OpenAPI document: 0.24.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.22.3
5
+ * The version of the OpenAPI document: 0.24.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.22.3
8
+ * The version of the OpenAPI document: 0.24.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,20 @@
1
+ # CreateChatChannel200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **chatChannelRef** | **string** | Reference to the chat channel resource | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CreateChatChannel200Response } from '@teemill/platform';
14
+
15
+ const instance: CreateChatChannel200Response = {
16
+ chatChannelRef,
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)
@@ -4,10 +4,73 @@ All URIs are relative to *https://localhost:8080*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**createChatChannel**](#createchatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel|
7
8
  |[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
8
9
  |[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
9
10
  |[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
10
11
 
12
+ # **createChatChannel**
13
+ > CreateChatChannel200Response createChatChannel()
14
+
15
+ Create a chat channel for a customer enquiry if it doesn\'t exist
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ EnquiriesApi,
22
+ Configuration
23
+ } from '@teemill/platform';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new EnquiriesApi(configuration);
27
+
28
+ let project: string; //Project unique identifier (default to undefined)
29
+ let platformId: string; //The platform identifier (default to undefined)
30
+ let enquiryId: string; //The enquiry identifier (default to undefined)
31
+
32
+ const { status, data } = await apiInstance.createChatChannel(
33
+ project,
34
+ platformId,
35
+ enquiryId
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
44
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
45
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
46
+
47
+
48
+ ### Return type
49
+
50
+ **CreateChatChannel200Response**
51
+
52
+ ### Authorization
53
+
54
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: application/json
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ |**200** | Chat channel created | - |
66
+ |**400** | Failed validation | - |
67
+ |**401** | Not authorised to access this resource | - |
68
+ |**403** | Refuse to authorize | - |
69
+ |**404** | Resource not found | - |
70
+ |**500** | Unknown server error | - |
71
+
72
+ [[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)
73
+
11
74
  # **getCustomerEnquiry**
12
75
  > Enquiry getCustomerEnquiry()
13
76
 
@@ -26,7 +89,7 @@ const apiInstance = new EnquiriesApi(configuration);
26
89
 
27
90
  let project: string; //Project unique identifier (default to undefined)
28
91
  let platformId: string; //The platform identifier (default to undefined)
29
- let enquiryId: string; // (default to undefined)
92
+ let enquiryId: string; //The enquiry identifier (default to undefined)
30
93
 
31
94
  const { status, data } = await apiInstance.getCustomerEnquiry(
32
95
  project,
@@ -41,7 +104,7 @@ const { status, data } = await apiInstance.getCustomerEnquiry(
41
104
  |------------- | ------------- | ------------- | -------------|
42
105
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
43
106
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
44
- | **enquiryId** | [**string**] | | defaults to undefined|
107
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
45
108
 
46
109
 
47
110
  ### Return type
@@ -160,7 +223,7 @@ const apiInstance = new EnquiriesApi(configuration);
160
223
 
161
224
  let project: string; //Project unique identifier (default to undefined)
162
225
  let platformId: string; //The platform identifier (default to undefined)
163
- let enquiryId: string; // (default to undefined)
226
+ let enquiryId: string; //The enquiry identifier (default to undefined)
164
227
 
165
228
  const { status, data } = await apiInstance.listCustomerEnquiryLogs(
166
229
  project,
@@ -175,7 +238,7 @@ const { status, data } = await apiInstance.listCustomerEnquiryLogs(
175
238
  |------------- | ------------- | ------------- | -------------|
176
239
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
177
240
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
178
- | **enquiryId** | [**string**] | | defaults to undefined|
241
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
179
242
 
180
243
 
181
244
  ### Return type
package/docs/Enquiry.md CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **status** | **string** | | [default to undefined]
18
18
  **read** | **boolean** | | [default to undefined]
19
19
  **extraInputs** | [**Array<EnquiryExtraInputsInner>**](EnquiryExtraInputsInner.md) | | [default to undefined]
20
+ **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
20
21
 
21
22
  ## Example
22
23
 
@@ -36,6 +37,7 @@ const instance: Enquiry = {
36
37
  status,
37
38
  read,
38
39
  extraInputs,
40
+ chatChannelRef,
39
41
  };
40
42
  ```
41
43
 
package/docs/Order.md CHANGED
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
25
25
  **statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) | | [optional] [default to undefined]
26
26
  **project** | [**Project**](Project.md) | | [default to undefined]
27
27
  **paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) | | [optional] [default to undefined]
28
+ **integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
28
29
 
29
30
  ## Example
30
31
 
@@ -52,6 +53,7 @@ const instance: Order = {
52
53
  statusHistory,
53
54
  project,
54
55
  paymentAttempts,
56
+ integrationType,
55
57
  };
56
58
  ```
57
59