@teemill/platform 0.19.0 → 0.20.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.19.0
7
+ * The version of the OpenAPI document: 0.20.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,6 +26,11 @@ import globalAxios from 'axios';
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
+ export const EnquiryStatusEnum = {
30
+ New: 'New',
31
+ Archived: 'Archived',
32
+ Priority: 'Priority'
33
+ };
29
34
  /**
30
35
  *
31
36
  * @export
@@ -416,6 +421,313 @@ export const ListCustomersSortByEnum = {
416
421
  LastPurchased: '+lastPurchased',
417
422
  LastPurchased2: '-lastPurchased'
418
423
  };
424
+ /**
425
+ * EnquiriesApi - axios parameter creator
426
+ * @export
427
+ */
428
+ export const EnquiriesApiAxiosParamCreator = function (configuration) {
429
+ return {
430
+ /**
431
+ * Get a customer enquiry
432
+ * @summary Get customer enquiry
433
+ * @param {string} project Project unique identifier
434
+ * @param {string} platformId The platform identifier
435
+ * @param {string} enquiryId
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ */
439
+ getCustomerEnquiry: (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('getCustomerEnquiry', 'project', project);
442
+ // verify required parameter 'platformId' is not null or undefined
443
+ assertParamExists('getCustomerEnquiry', 'platformId', platformId);
444
+ // verify required parameter 'enquiryId' is not null or undefined
445
+ assertParamExists('getCustomerEnquiry', 'enquiryId', enquiryId);
446
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
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: 'GET' }, 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
+ }),
474
+ /**
475
+ * List customer enquiries
476
+ * @summary List customer enquiries
477
+ * @param {string} project Project unique identifier
478
+ * @param {string} platformId The platform identifier
479
+ * @param {number} [pageToken] Page reference token
480
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
481
+ * @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
482
+ * @param {string} [start] Start of date range to filter by
483
+ * @param {string} [end] End of date range to filter by
484
+ * @param {*} [options] Override http request option.
485
+ * @throws {RequiredError}
486
+ */
487
+ listCustomerEnquiries: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, options = {}) {
488
+ // verify required parameter 'project' is not null or undefined
489
+ assertParamExists('listCustomerEnquiries', 'project', project);
490
+ // verify required parameter 'platformId' is not null or undefined
491
+ assertParamExists('listCustomerEnquiries', 'platformId', platformId);
492
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries`
493
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
494
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
495
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
496
+ let baseOptions;
497
+ if (configuration) {
498
+ baseOptions = configuration.baseOptions;
499
+ }
500
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
501
+ const localVarHeaderParameter = {};
502
+ const localVarQueryParameter = {};
503
+ // authentication session-oauth required
504
+ // oauth required
505
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
506
+ // authentication api-key required
507
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
508
+ if (project !== undefined) {
509
+ localVarQueryParameter['project'] = project;
510
+ }
511
+ if (pageToken !== undefined) {
512
+ localVarQueryParameter['pageToken'] = pageToken;
513
+ }
514
+ if (pageSize !== undefined) {
515
+ localVarQueryParameter['pageSize'] = pageSize;
516
+ }
517
+ if (search !== undefined) {
518
+ localVarQueryParameter['search'] = search;
519
+ }
520
+ if (start !== undefined) {
521
+ localVarQueryParameter['start'] = (start instanceof Date) ?
522
+ start.toISOString() :
523
+ start;
524
+ }
525
+ if (end !== undefined) {
526
+ localVarQueryParameter['end'] = (end instanceof Date) ?
527
+ end.toISOString() :
528
+ end;
529
+ }
530
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
531
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
532
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
533
+ return {
534
+ url: toPathString(localVarUrlObj),
535
+ options: localVarRequestOptions,
536
+ };
537
+ }),
538
+ /**
539
+ * Lists all customer enquiry Logs
540
+ * @summary List customer enquiry Logs
541
+ * @param {string} project Project unique identifier
542
+ * @param {string} platformId The platform identifier
543
+ * @param {string} enquiryId
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ listCustomerEnquiryLogs: (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 = {}) {
548
+ // verify required parameter 'project' is not null or undefined
549
+ assertParamExists('listCustomerEnquiryLogs', 'project', project);
550
+ // verify required parameter 'platformId' is not null or undefined
551
+ assertParamExists('listCustomerEnquiryLogs', 'platformId', platformId);
552
+ // verify required parameter 'enquiryId' is not null or undefined
553
+ assertParamExists('listCustomerEnquiryLogs', 'enquiryId', enquiryId);
554
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs`
555
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
556
+ .replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
557
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
558
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
559
+ let baseOptions;
560
+ if (configuration) {
561
+ baseOptions = configuration.baseOptions;
562
+ }
563
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
564
+ const localVarHeaderParameter = {};
565
+ const localVarQueryParameter = {};
566
+ // authentication session-oauth required
567
+ // oauth required
568
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
569
+ // authentication api-key required
570
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
571
+ if (project !== undefined) {
572
+ localVarQueryParameter['project'] = project;
573
+ }
574
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
575
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
576
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
577
+ return {
578
+ url: toPathString(localVarUrlObj),
579
+ options: localVarRequestOptions,
580
+ };
581
+ }),
582
+ };
583
+ };
584
+ /**
585
+ * EnquiriesApi - functional programming interface
586
+ * @export
587
+ */
588
+ export const EnquiriesApiFp = function (configuration) {
589
+ const localVarAxiosParamCreator = EnquiriesApiAxiosParamCreator(configuration);
590
+ return {
591
+ /**
592
+ * Get a customer enquiry
593
+ * @summary Get customer enquiry
594
+ * @param {string} project Project unique identifier
595
+ * @param {string} platformId The platform identifier
596
+ * @param {string} enquiryId
597
+ * @param {*} [options] Override http request option.
598
+ * @throws {RequiredError}
599
+ */
600
+ getCustomerEnquiry(project, platformId, enquiryId, options) {
601
+ return __awaiter(this, void 0, void 0, function* () {
602
+ var _a, _b, _c;
603
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomerEnquiry(project, platformId, enquiryId, options);
604
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
605
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EnquiriesApi.getCustomerEnquiry']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
606
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
607
+ });
608
+ },
609
+ /**
610
+ * List customer enquiries
611
+ * @summary List customer enquiries
612
+ * @param {string} project Project unique identifier
613
+ * @param {string} platformId The platform identifier
614
+ * @param {number} [pageToken] Page reference token
615
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
616
+ * @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
617
+ * @param {string} [start] Start of date range to filter by
618
+ * @param {string} [end] End of date range to filter by
619
+ * @param {*} [options] Override http request option.
620
+ * @throws {RequiredError}
621
+ */
622
+ listCustomerEnquiries(project, platformId, pageToken, pageSize, search, start, end, options) {
623
+ return __awaiter(this, void 0, void 0, function* () {
624
+ var _a, _b, _c;
625
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomerEnquiries(project, platformId, pageToken, pageSize, search, start, end, options);
626
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
627
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EnquiriesApi.listCustomerEnquiries']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
628
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
629
+ });
630
+ },
631
+ /**
632
+ * Lists all customer enquiry Logs
633
+ * @summary List customer enquiry Logs
634
+ * @param {string} project Project unique identifier
635
+ * @param {string} platformId The platform identifier
636
+ * @param {string} enquiryId
637
+ * @param {*} [options] Override http request option.
638
+ * @throws {RequiredError}
639
+ */
640
+ listCustomerEnquiryLogs(project, platformId, enquiryId, options) {
641
+ return __awaiter(this, void 0, void 0, function* () {
642
+ var _a, _b, _c;
643
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomerEnquiryLogs(project, platformId, enquiryId, options);
644
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
645
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EnquiriesApi.listCustomerEnquiryLogs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
646
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
647
+ });
648
+ },
649
+ };
650
+ };
651
+ /**
652
+ * EnquiriesApi - factory interface
653
+ * @export
654
+ */
655
+ export const EnquiriesApiFactory = function (configuration, basePath, axios) {
656
+ const localVarFp = EnquiriesApiFp(configuration);
657
+ return {
658
+ /**
659
+ * Get a customer enquiry
660
+ * @summary Get customer enquiry
661
+ * @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
662
+ * @param {*} [options] Override http request option.
663
+ * @throws {RequiredError}
664
+ */
665
+ getCustomerEnquiry(requestParameters, options) {
666
+ return localVarFp.getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
667
+ },
668
+ /**
669
+ * List customer enquiries
670
+ * @summary List customer enquiries
671
+ * @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
672
+ * @param {*} [options] Override http request option.
673
+ * @throws {RequiredError}
674
+ */
675
+ listCustomerEnquiries(requestParameters, options) {
676
+ return localVarFp.listCustomerEnquiries(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
677
+ },
678
+ /**
679
+ * Lists all customer enquiry Logs
680
+ * @summary List customer enquiry Logs
681
+ * @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
682
+ * @param {*} [options] Override http request option.
683
+ * @throws {RequiredError}
684
+ */
685
+ listCustomerEnquiryLogs(requestParameters, options) {
686
+ return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
687
+ },
688
+ };
689
+ };
690
+ /**
691
+ * EnquiriesApi - object-oriented interface
692
+ * @export
693
+ * @class EnquiriesApi
694
+ * @extends {BaseAPI}
695
+ */
696
+ export class EnquiriesApi extends BaseAPI {
697
+ /**
698
+ * Get a customer enquiry
699
+ * @summary Get customer enquiry
700
+ * @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
701
+ * @param {*} [options] Override http request option.
702
+ * @throws {RequiredError}
703
+ * @memberof EnquiriesApi
704
+ */
705
+ getCustomerEnquiry(requestParameters, options) {
706
+ return EnquiriesApiFp(this.configuration).getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
707
+ }
708
+ /**
709
+ * List customer enquiries
710
+ * @summary List customer enquiries
711
+ * @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
712
+ * @param {*} [options] Override http request option.
713
+ * @throws {RequiredError}
714
+ * @memberof EnquiriesApi
715
+ */
716
+ listCustomerEnquiries(requestParameters, options) {
717
+ return EnquiriesApiFp(this.configuration).listCustomerEnquiries(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
718
+ }
719
+ /**
720
+ * Lists all customer enquiry Logs
721
+ * @summary List customer enquiry Logs
722
+ * @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
723
+ * @param {*} [options] Override http request option.
724
+ * @throws {RequiredError}
725
+ * @memberof EnquiriesApi
726
+ */
727
+ listCustomerEnquiryLogs(requestParameters, options) {
728
+ return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
729
+ }
730
+ }
419
731
  /**
420
732
  * OrdersApi - axios parameter creator
421
733
  * @export
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.19.0
5
+ * The version of the OpenAPI document: 0.20.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.19.0
7
+ * The version of the OpenAPI document: 0.20.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.19.0
5
+ * The version of the OpenAPI document: 0.20.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.19.0
7
+ * The version of the OpenAPI document: 0.20.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.19.0
5
+ * The version of the OpenAPI document: 0.20.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.19.0
7
+ * The version of the OpenAPI document: 0.20.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.19.0
5
+ * The version of the OpenAPI document: 0.20.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.19.0
7
+ * The version of the OpenAPI document: 0.20.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.19.0
5
+ * The version of the OpenAPI document: 0.20.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.19.0
8
+ * The version of the OpenAPI document: 0.20.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/Client.md ADDED
@@ -0,0 +1,24 @@
1
+ # Client
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **ref** | **string** | API reference for the client | [optional] [default to undefined]
10
+ **name** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { Client } from '@teemill/platform';
16
+
17
+ const instance: Client = {
18
+ id,
19
+ ref,
20
+ name,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,204 @@
1
+ # EnquiriesApi
2
+
3
+ All URIs are relative to *https://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
8
+ |[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
9
+ |[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
10
+
11
+ # **getCustomerEnquiry**
12
+ > Enquiry getCustomerEnquiry()
13
+
14
+ Get a customer enquiry
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ EnquiriesApi,
21
+ Configuration
22
+ } from '@teemill/platform';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new EnquiriesApi(configuration);
26
+
27
+ let project: string; //Project unique identifier (default to undefined)
28
+ let platformId: string; //The platform identifier (default to undefined)
29
+ let enquiryId: string; // (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.getCustomerEnquiry(
32
+ project,
33
+ platformId,
34
+ enquiryId
35
+ );
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ |Name | Type | Description | Notes|
41
+ |------------- | ------------- | ------------- | -------------|
42
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
43
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
44
+ | **enquiryId** | [**string**] | | defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **Enquiry**
50
+
51
+ ### Authorization
52
+
53
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | A customer enquiry | - |
65
+ |**401** | Not authorised to access this resource | - |
66
+ |**403** | Refuse to authorize | - |
67
+ |**404** | Resource not found | - |
68
+ |**500** | Unknown server error | - |
69
+
70
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
71
+
72
+ # **listCustomerEnquiries**
73
+ > ListCustomerEnquiries200Response listCustomerEnquiries()
74
+
75
+ List customer enquiries
76
+
77
+ ### Example
78
+
79
+ ```typescript
80
+ import {
81
+ EnquiriesApi,
82
+ Configuration
83
+ } from '@teemill/platform';
84
+
85
+ const configuration = new Configuration();
86
+ const apiInstance = new EnquiriesApi(configuration);
87
+
88
+ let project: string; //Project unique identifier (default to undefined)
89
+ let platformId: string; //The platform identifier (default to undefined)
90
+ let pageToken: number; //Page reference token (optional) (default to 1)
91
+ let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
92
+ let search: string; //Search term to filter based on enquiry title, content, customer name and customer email. (optional) (default to undefined)
93
+ let start: string; //Start of date range to filter by (optional) (default to undefined)
94
+ let end: string; //End of date range to filter by (optional) (default to undefined)
95
+
96
+ const { status, data } = await apiInstance.listCustomerEnquiries(
97
+ project,
98
+ platformId,
99
+ pageToken,
100
+ pageSize,
101
+ search,
102
+ start,
103
+ end
104
+ );
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ |Name | Type | Description | Notes|
110
+ |------------- | ------------- | ------------- | -------------|
111
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
112
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
113
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
114
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
115
+ | **search** | [**string**] | Search term to filter based on enquiry title, content, customer name and customer email. | (optional) defaults to undefined|
116
+ | **start** | [**string**] | Start of date range to filter by | (optional) defaults to undefined|
117
+ | **end** | [**string**] | End of date range to filter by | (optional) defaults to undefined|
118
+
119
+
120
+ ### Return type
121
+
122
+ **ListCustomerEnquiries200Response**
123
+
124
+ ### Authorization
125
+
126
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
127
+
128
+ ### HTTP request headers
129
+
130
+ - **Content-Type**: Not defined
131
+ - **Accept**: application/json
132
+
133
+
134
+ ### HTTP response details
135
+ | Status code | Description | Response headers |
136
+ |-------------|-------------|------------------|
137
+ |**200** | A list of customer enquiries | - |
138
+ |**400** | Failed validation | - |
139
+ |**401** | Not authorised to access this resource | - |
140
+ |**403** | Refuse to authorize | - |
141
+ |**500** | Unknown server error | - |
142
+
143
+ [[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)
144
+
145
+ # **listCustomerEnquiryLogs**
146
+ > ListCustomerEnquiryLogs200Response listCustomerEnquiryLogs()
147
+
148
+ Lists all customer enquiry Logs
149
+
150
+ ### Example
151
+
152
+ ```typescript
153
+ import {
154
+ EnquiriesApi,
155
+ Configuration
156
+ } from '@teemill/platform';
157
+
158
+ const configuration = new Configuration();
159
+ const apiInstance = new EnquiriesApi(configuration);
160
+
161
+ let project: string; //Project unique identifier (default to undefined)
162
+ let platformId: string; //The platform identifier (default to undefined)
163
+ let enquiryId: string; // (default to undefined)
164
+
165
+ const { status, data } = await apiInstance.listCustomerEnquiryLogs(
166
+ project,
167
+ platformId,
168
+ enquiryId
169
+ );
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ |Name | Type | Description | Notes|
175
+ |------------- | ------------- | ------------- | -------------|
176
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
177
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
178
+ | **enquiryId** | [**string**] | | defaults to undefined|
179
+
180
+
181
+ ### Return type
182
+
183
+ **ListCustomerEnquiryLogs200Response**
184
+
185
+ ### Authorization
186
+
187
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: application/json
193
+
194
+
195
+ ### HTTP response details
196
+ | Status code | Description | Response headers |
197
+ |-------------|-------------|------------------|
198
+ |**200** | A list of customer enquiry logs belonging to the enquiry | - |
199
+ |**401** | Not authorised to access this resource | - |
200
+ |**403** | Refuse to authorize | - |
201
+ |**500** | Unknown server error | - |
202
+
203
+ [[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)
204
+