ultracart_rest_api_v2_typescript 3.10.80 → 3.10.81

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
- ## ultracart_rest_api_v2_typescript@3.10.80
1
+ ## ultracart_rest_api_v2_typescript@3.10.81
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 ultracart_rest_api_v2_typescript@3.10.80 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.81 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.81 | 12/15/2022 | conversation searching |
57
58
  | 3.10.80 | 12/13/2022 | conversations - add email and sms_phone to participant object |
58
59
  | 3.10.79 | 12/09/2022 | conversations - message translation |
59
60
  | 3.10.78 | 12/08/2022 | conversation canned messages |
package/api.ts CHANGED
@@ -6552,6 +6552,76 @@ export interface ConversationAgentAuthResponse {
6552
6552
  warning?: Warning;
6553
6553
  }
6554
6554
 
6555
+ /**
6556
+ *
6557
+ * @export
6558
+ * @interface ConversationAutocompleteRequest
6559
+ */
6560
+ export interface ConversationAutocompleteRequest {
6561
+ /**
6562
+ *
6563
+ * @type {string}
6564
+ * @memberof ConversationAutocompleteRequest
6565
+ */
6566
+ field?: string;
6567
+ /**
6568
+ *
6569
+ * @type {string}
6570
+ * @memberof ConversationAutocompleteRequest
6571
+ */
6572
+ term?: string;
6573
+ }
6574
+
6575
+ /**
6576
+ *
6577
+ * @export
6578
+ * @interface ConversationAutocompleteResponse
6579
+ */
6580
+ export interface ConversationAutocompleteResponse {
6581
+ /**
6582
+ *
6583
+ * @type {ModelError}
6584
+ * @memberof ConversationAutocompleteResponse
6585
+ */
6586
+ error?: ModelError;
6587
+ /**
6588
+ *
6589
+ * @type {string}
6590
+ * @memberof ConversationAutocompleteResponse
6591
+ */
6592
+ field?: string;
6593
+ /**
6594
+ *
6595
+ * @type {ResponseMetadata}
6596
+ * @memberof ConversationAutocompleteResponse
6597
+ */
6598
+ metadata?: ResponseMetadata;
6599
+ /**
6600
+ *
6601
+ * @type {Array<string>}
6602
+ * @memberof ConversationAutocompleteResponse
6603
+ */
6604
+ results?: Array<string>;
6605
+ /**
6606
+ * Indicates if API call was successful
6607
+ * @type {boolean}
6608
+ * @memberof ConversationAutocompleteResponse
6609
+ */
6610
+ success?: boolean;
6611
+ /**
6612
+ *
6613
+ * @type {string}
6614
+ * @memberof ConversationAutocompleteResponse
6615
+ */
6616
+ term?: string;
6617
+ /**
6618
+ *
6619
+ * @type {Warning}
6620
+ * @memberof ConversationAutocompleteResponse
6621
+ */
6622
+ warning?: Warning;
6623
+ }
6624
+
6555
6625
  /**
6556
6626
  *
6557
6627
  * @export
@@ -7562,6 +7632,100 @@ export interface ConversationResponse {
7562
7632
  warning?: Warning;
7563
7633
  }
7564
7634
 
7635
+ /**
7636
+ *
7637
+ * @export
7638
+ * @interface ConversationSearchRequest
7639
+ */
7640
+ export interface ConversationSearchRequest {
7641
+ /**
7642
+ *
7643
+ * @type {string}
7644
+ * @memberof ConversationSearchRequest
7645
+ */
7646
+ email_filter?: string;
7647
+ /**
7648
+ *
7649
+ * @type {string}
7650
+ * @memberof ConversationSearchRequest
7651
+ */
7652
+ language_filter?: string;
7653
+ /**
7654
+ *
7655
+ * @type {string}
7656
+ * @memberof ConversationSearchRequest
7657
+ */
7658
+ medium_filter?: string;
7659
+ /**
7660
+ *
7661
+ * @type {boolean}
7662
+ * @memberof ConversationSearchRequest
7663
+ */
7664
+ order_by_newest?: boolean;
7665
+ /**
7666
+ *
7667
+ * @type {boolean}
7668
+ * @memberof ConversationSearchRequest
7669
+ */
7670
+ order_by_oldest?: boolean;
7671
+ /**
7672
+ *
7673
+ * @type {number}
7674
+ * @memberof ConversationSearchRequest
7675
+ */
7676
+ range_begin?: number;
7677
+ /**
7678
+ *
7679
+ * @type {number}
7680
+ * @memberof ConversationSearchRequest
7681
+ */
7682
+ range_end?: number;
7683
+ /**
7684
+ *
7685
+ * @type {string}
7686
+ * @memberof ConversationSearchRequest
7687
+ */
7688
+ sms_phone_number_filter?: string;
7689
+ /**
7690
+ *
7691
+ * @type {string}
7692
+ * @memberof ConversationSearchRequest
7693
+ */
7694
+ text_search?: string;
7695
+ /**
7696
+ *
7697
+ * @type {boolean}
7698
+ * @memberof ConversationSearchRequest
7699
+ */
7700
+ visible_filter?: boolean;
7701
+ }
7702
+
7703
+ /**
7704
+ *
7705
+ * @export
7706
+ * @interface ConversationSearchResponse
7707
+ */
7708
+ export interface ConversationSearchResponse {
7709
+ /**
7710
+ *
7711
+ * @type {number}
7712
+ * @memberof ConversationSearchResponse
7713
+ */
7714
+ range_begin?: number;
7715
+ /**
7716
+ *
7717
+ * @type {number}
7718
+ * @memberof ConversationSearchResponse
7719
+ */
7720
+ range_end?: number;
7721
+ /**
7722
+ *
7723
+ * @type {number}
7724
+ * @memberof ConversationSearchResponse
7725
+ */
7726
+ total?: number;
7727
+ }
7728
+
7565
7729
  /**
7566
7730
  *
7567
7731
  * @export
@@ -42567,6 +42731,116 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
42567
42731
  options: localVarRequestOptions,
42568
42732
  };
42569
42733
  },
42734
+ /**
42735
+ * Retrieve a list of matching terms for a search field
42736
+ * @summary Retrieve a list of matching terms for a search field
42737
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
42738
+ * @param {*} [options] Override http request option.
42739
+ * @throws {RequiredError}
42740
+ */
42741
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options: any = {}): FetchArgs {
42742
+ // verify required parameter 'autocomplete_request' is not null or undefined
42743
+ if (autocomplete_request === null || autocomplete_request === undefined) {
42744
+ throw new RequiredError('autocomplete_request','Required parameter autocomplete_request was null or undefined when calling getConversationsAutocomplete.');
42745
+ }
42746
+ const localVarPath = `/conversation/conversations/autocomplete`;
42747
+ const localVarUrlObj = url.parse(localVarPath, true);
42748
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
42749
+ const localVarHeaderParameter = {} as any;
42750
+ const localVarQueryParameter = {} as any;
42751
+
42752
+ if(configuration && configuration.apiVersion) {
42753
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
42754
+ }
42755
+
42756
+
42757
+
42758
+ // authentication ultraCartOauth required
42759
+ // oauth required
42760
+ if (configuration && configuration.accessToken) {
42761
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
42762
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
42763
+ : configuration.accessToken;
42764
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
42765
+ }
42766
+
42767
+ // authentication ultraCartSimpleApiKey required
42768
+ if (configuration && configuration.apiKey) {
42769
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
42770
+ ? configuration.apiKey("x-ultracart-simple-key")
42771
+ : configuration.apiKey;
42772
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
42773
+ }
42774
+
42775
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42776
+
42777
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
42778
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
42779
+ delete localVarUrlObj.search;
42780
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
42781
+ const needsSerialization = (<any>"ConversationAutocompleteRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
42782
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(autocomplete_request || {}) : (autocomplete_request || "");
42783
+
42784
+ return {
42785
+ url: url.format(localVarUrlObj),
42786
+ options: localVarRequestOptions,
42787
+ };
42788
+ },
42789
+ /**
42790
+ * Search conversations
42791
+ * @summary Search conversations
42792
+ * @param {ConversationSearchRequest} search_request Search Request
42793
+ * @param {*} [options] Override http request option.
42794
+ * @throws {RequiredError}
42795
+ */
42796
+ getConversationsSearch(search_request: ConversationSearchRequest, options: any = {}): FetchArgs {
42797
+ // verify required parameter 'search_request' is not null or undefined
42798
+ if (search_request === null || search_request === undefined) {
42799
+ throw new RequiredError('search_request','Required parameter search_request was null or undefined when calling getConversationsSearch.');
42800
+ }
42801
+ const localVarPath = `/conversation/conversations/search`;
42802
+ const localVarUrlObj = url.parse(localVarPath, true);
42803
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
42804
+ const localVarHeaderParameter = {} as any;
42805
+ const localVarQueryParameter = {} as any;
42806
+
42807
+ if(configuration && configuration.apiVersion) {
42808
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
42809
+ }
42810
+
42811
+
42812
+
42813
+ // authentication ultraCartOauth required
42814
+ // oauth required
42815
+ if (configuration && configuration.accessToken) {
42816
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
42817
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
42818
+ : configuration.accessToken;
42819
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
42820
+ }
42821
+
42822
+ // authentication ultraCartSimpleApiKey required
42823
+ if (configuration && configuration.apiKey) {
42824
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
42825
+ ? configuration.apiKey("x-ultracart-simple-key")
42826
+ : configuration.apiKey;
42827
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
42828
+ }
42829
+
42830
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42831
+
42832
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
42833
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
42834
+ delete localVarUrlObj.search;
42835
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
42836
+ const needsSerialization = (<any>"ConversationSearchRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
42837
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(search_request || {}) : (search_request || "");
42838
+
42839
+ return {
42840
+ url: url.format(localVarUrlObj),
42841
+ options: localVarRequestOptions,
42842
+ };
42843
+ },
42570
42844
  /**
42571
42845
  * Insert a canned message
42572
42846
  * @summary Insert a canned message
@@ -43487,6 +43761,48 @@ export const ConversationApiFp = function(configuration?: Configuration) {
43487
43761
  });
43488
43762
  };
43489
43763
  },
43764
+ /**
43765
+ * Retrieve a list of matching terms for a search field
43766
+ * @summary Retrieve a list of matching terms for a search field
43767
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
43768
+ * @param {*} [options] Override http request option.
43769
+ * @throws {RequiredError}
43770
+ */
43771
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAutocompleteResponse> {
43772
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationsAutocomplete(autocomplete_request, options);
43773
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
43774
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
43775
+
43776
+ if (response.status >= 200 && response.status < 300) {
43777
+ return response.json();
43778
+
43779
+ } else {
43780
+ throw response;
43781
+ }
43782
+ });
43783
+ };
43784
+ },
43785
+ /**
43786
+ * Search conversations
43787
+ * @summary Search conversations
43788
+ * @param {ConversationSearchRequest} search_request Search Request
43789
+ * @param {*} [options] Override http request option.
43790
+ * @throws {RequiredError}
43791
+ */
43792
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationSearchResponse> {
43793
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationsSearch(search_request, options);
43794
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
43795
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
43796
+
43797
+ if (response.status >= 200 && response.status < 300) {
43798
+ return response.json();
43799
+
43800
+ } else {
43801
+ throw response;
43802
+ }
43803
+ });
43804
+ };
43805
+ },
43490
43806
  /**
43491
43807
  * Insert a canned message
43492
43808
  * @summary Insert a canned message
@@ -43863,6 +44179,26 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
43863
44179
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any) {
43864
44180
  return ConversationApiFp(configuration).getConversations(medium, before, _limit, _offset, options)(fetch, basePath);
43865
44181
  },
44182
+ /**
44183
+ * Retrieve a list of matching terms for a search field
44184
+ * @summary Retrieve a list of matching terms for a search field
44185
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44186
+ * @param {*} [options] Override http request option.
44187
+ * @throws {RequiredError}
44188
+ */
44189
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any) {
44190
+ return ConversationApiFp(configuration).getConversationsAutocomplete(autocomplete_request, options)(fetch, basePath);
44191
+ },
44192
+ /**
44193
+ * Search conversations
44194
+ * @summary Search conversations
44195
+ * @param {ConversationSearchRequest} search_request Search Request
44196
+ * @param {*} [options] Override http request option.
44197
+ * @throws {RequiredError}
44198
+ */
44199
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any) {
44200
+ return ConversationApiFp(configuration).getConversationsSearch(search_request, options)(fetch, basePath);
44201
+ },
43866
44202
  /**
43867
44203
  * Insert a canned message
43868
44204
  * @summary Insert a canned message
@@ -44107,6 +44443,26 @@ export interface ConversationApiInterface {
44107
44443
  */
44108
44444
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
44109
44445
 
44446
+ /**
44447
+ * Retrieve a list of matching terms for a search field
44448
+ * @summary Retrieve a list of matching terms for a search field
44449
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44450
+ * @param {*} [options] Override http request option.
44451
+ * @throws {RequiredError}
44452
+ * @memberof ConversationApiInterface
44453
+ */
44454
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
44455
+
44456
+ /**
44457
+ * Search conversations
44458
+ * @summary Search conversations
44459
+ * @param {ConversationSearchRequest} search_request Search Request
44460
+ * @param {*} [options] Override http request option.
44461
+ * @throws {RequiredError}
44462
+ * @memberof ConversationApiInterface
44463
+ */
44464
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
44465
+
44110
44466
  /**
44111
44467
  * Insert a canned message
44112
44468
  * @summary Insert a canned message
@@ -44373,6 +44729,30 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
44373
44729
  return ConversationApiFp(this.configuration).getConversations(medium, before, _limit, _offset, options)(this.fetch, this.basePath);
44374
44730
  }
44375
44731
 
44732
+ /**
44733
+ * Retrieve a list of matching terms for a search field
44734
+ * @summary Retrieve a list of matching terms for a search field
44735
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44736
+ * @param {*} [options] Override http request option.
44737
+ * @throws {RequiredError}
44738
+ * @memberof ConversationApi
44739
+ */
44740
+ public getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any) {
44741
+ return ConversationApiFp(this.configuration).getConversationsAutocomplete(autocomplete_request, options)(this.fetch, this.basePath);
44742
+ }
44743
+
44744
+ /**
44745
+ * Search conversations
44746
+ * @summary Search conversations
44747
+ * @param {ConversationSearchRequest} search_request Search Request
44748
+ * @param {*} [options] Override http request option.
44749
+ * @throws {RequiredError}
44750
+ * @memberof ConversationApi
44751
+ */
44752
+ public getConversationsSearch(search_request: ConversationSearchRequest, options?: any) {
44753
+ return ConversationApiFp(this.configuration).getConversationsSearch(search_request, options)(this.fetch, this.basePath);
44754
+ }
44755
+
44376
44756
  /**
44377
44757
  * Insert a canned message
44378
44758
  * @summary Insert a canned message
package/dist/api.d.ts CHANGED
@@ -6400,6 +6400,74 @@ export interface ConversationAgentAuthResponse {
6400
6400
  */
6401
6401
  warning?: Warning;
6402
6402
  }
6403
+ /**
6404
+ *
6405
+ * @export
6406
+ * @interface ConversationAutocompleteRequest
6407
+ */
6408
+ export interface ConversationAutocompleteRequest {
6409
+ /**
6410
+ *
6411
+ * @type {string}
6412
+ * @memberof ConversationAutocompleteRequest
6413
+ */
6414
+ field?: string;
6415
+ /**
6416
+ *
6417
+ * @type {string}
6418
+ * @memberof ConversationAutocompleteRequest
6419
+ */
6420
+ term?: string;
6421
+ }
6422
+ /**
6423
+ *
6424
+ * @export
6425
+ * @interface ConversationAutocompleteResponse
6426
+ */
6427
+ export interface ConversationAutocompleteResponse {
6428
+ /**
6429
+ *
6430
+ * @type {ModelError}
6431
+ * @memberof ConversationAutocompleteResponse
6432
+ */
6433
+ error?: ModelError;
6434
+ /**
6435
+ *
6436
+ * @type {string}
6437
+ * @memberof ConversationAutocompleteResponse
6438
+ */
6439
+ field?: string;
6440
+ /**
6441
+ *
6442
+ * @type {ResponseMetadata}
6443
+ * @memberof ConversationAutocompleteResponse
6444
+ */
6445
+ metadata?: ResponseMetadata;
6446
+ /**
6447
+ *
6448
+ * @type {Array<string>}
6449
+ * @memberof ConversationAutocompleteResponse
6450
+ */
6451
+ results?: Array<string>;
6452
+ /**
6453
+ * Indicates if API call was successful
6454
+ * @type {boolean}
6455
+ * @memberof ConversationAutocompleteResponse
6456
+ */
6457
+ success?: boolean;
6458
+ /**
6459
+ *
6460
+ * @type {string}
6461
+ * @memberof ConversationAutocompleteResponse
6462
+ */
6463
+ term?: string;
6464
+ /**
6465
+ *
6466
+ * @type {Warning}
6467
+ * @memberof ConversationAutocompleteResponse
6468
+ */
6469
+ warning?: Warning;
6470
+ }
6403
6471
  /**
6404
6472
  *
6405
6473
  * @export
@@ -7379,6 +7447,98 @@ export interface ConversationResponse {
7379
7447
  */
7380
7448
  warning?: Warning;
7381
7449
  }
7450
+ /**
7451
+ *
7452
+ * @export
7453
+ * @interface ConversationSearchRequest
7454
+ */
7455
+ export interface ConversationSearchRequest {
7456
+ /**
7457
+ *
7458
+ * @type {string}
7459
+ * @memberof ConversationSearchRequest
7460
+ */
7461
+ email_filter?: string;
7462
+ /**
7463
+ *
7464
+ * @type {string}
7465
+ * @memberof ConversationSearchRequest
7466
+ */
7467
+ language_filter?: string;
7468
+ /**
7469
+ *
7470
+ * @type {string}
7471
+ * @memberof ConversationSearchRequest
7472
+ */
7473
+ medium_filter?: string;
7474
+ /**
7475
+ *
7476
+ * @type {boolean}
7477
+ * @memberof ConversationSearchRequest
7478
+ */
7479
+ order_by_newest?: boolean;
7480
+ /**
7481
+ *
7482
+ * @type {boolean}
7483
+ * @memberof ConversationSearchRequest
7484
+ */
7485
+ order_by_oldest?: boolean;
7486
+ /**
7487
+ *
7488
+ * @type {number}
7489
+ * @memberof ConversationSearchRequest
7490
+ */
7491
+ range_begin?: number;
7492
+ /**
7493
+ *
7494
+ * @type {number}
7495
+ * @memberof ConversationSearchRequest
7496
+ */
7497
+ range_end?: number;
7498
+ /**
7499
+ *
7500
+ * @type {string}
7501
+ * @memberof ConversationSearchRequest
7502
+ */
7503
+ sms_phone_number_filter?: string;
7504
+ /**
7505
+ *
7506
+ * @type {string}
7507
+ * @memberof ConversationSearchRequest
7508
+ */
7509
+ text_search?: string;
7510
+ /**
7511
+ *
7512
+ * @type {boolean}
7513
+ * @memberof ConversationSearchRequest
7514
+ */
7515
+ visible_filter?: boolean;
7516
+ }
7517
+ /**
7518
+ *
7519
+ * @export
7520
+ * @interface ConversationSearchResponse
7521
+ */
7522
+ export interface ConversationSearchResponse {
7523
+ /**
7524
+ *
7525
+ * @type {number}
7526
+ * @memberof ConversationSearchResponse
7527
+ */
7528
+ range_begin?: number;
7529
+ /**
7530
+ *
7531
+ * @type {number}
7532
+ * @memberof ConversationSearchResponse
7533
+ */
7534
+ range_end?: number;
7535
+ /**
7536
+ *
7537
+ * @type {number}
7538
+ * @memberof ConversationSearchResponse
7539
+ */
7540
+ total?: number;
7541
+ }
7382
7542
  /**
7383
7543
  *
7384
7544
  * @export
@@ -38325,6 +38485,22 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
38325
38485
  * @throws {RequiredError}
38326
38486
  */
38327
38487
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): FetchArgs;
38488
+ /**
38489
+ * Retrieve a list of matching terms for a search field
38490
+ * @summary Retrieve a list of matching terms for a search field
38491
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38492
+ * @param {*} [options] Override http request option.
38493
+ * @throws {RequiredError}
38494
+ */
38495
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): FetchArgs;
38496
+ /**
38497
+ * Search conversations
38498
+ * @summary Search conversations
38499
+ * @param {ConversationSearchRequest} search_request Search Request
38500
+ * @param {*} [options] Override http request option.
38501
+ * @throws {RequiredError}
38502
+ */
38503
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): FetchArgs;
38328
38504
  /**
38329
38505
  * Insert a canned message
38330
38506
  * @summary Insert a canned message
@@ -38520,6 +38696,22 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
38520
38696
  * @throws {RequiredError}
38521
38697
  */
38522
38698
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse>;
38699
+ /**
38700
+ * Retrieve a list of matching terms for a search field
38701
+ * @summary Retrieve a list of matching terms for a search field
38702
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38703
+ * @param {*} [options] Override http request option.
38704
+ * @throws {RequiredError}
38705
+ */
38706
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAutocompleteResponse>;
38707
+ /**
38708
+ * Search conversations
38709
+ * @summary Search conversations
38710
+ * @param {ConversationSearchRequest} search_request Search Request
38711
+ * @param {*} [options] Override http request option.
38712
+ * @throws {RequiredError}
38713
+ */
38714
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationSearchResponse>;
38523
38715
  /**
38524
38716
  * Insert a canned message
38525
38717
  * @summary Insert a canned message
@@ -38715,6 +38907,22 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
38715
38907
  * @throws {RequiredError}
38716
38908
  */
38717
38909
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
38910
+ /**
38911
+ * Retrieve a list of matching terms for a search field
38912
+ * @summary Retrieve a list of matching terms for a search field
38913
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38914
+ * @param {*} [options] Override http request option.
38915
+ * @throws {RequiredError}
38916
+ */
38917
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
38918
+ /**
38919
+ * Search conversations
38920
+ * @summary Search conversations
38921
+ * @param {ConversationSearchRequest} search_request Search Request
38922
+ * @param {*} [options] Override http request option.
38923
+ * @throws {RequiredError}
38924
+ */
38925
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
38718
38926
  /**
38719
38927
  * Insert a canned message
38720
38928
  * @summary Insert a canned message
@@ -38922,6 +39130,24 @@ export interface ConversationApiInterface {
38922
39130
  * @memberof ConversationApiInterface
38923
39131
  */
38924
39132
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
39133
+ /**
39134
+ * Retrieve a list of matching terms for a search field
39135
+ * @summary Retrieve a list of matching terms for a search field
39136
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
39137
+ * @param {*} [options] Override http request option.
39138
+ * @throws {RequiredError}
39139
+ * @memberof ConversationApiInterface
39140
+ */
39141
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
39142
+ /**
39143
+ * Search conversations
39144
+ * @summary Search conversations
39145
+ * @param {ConversationSearchRequest} search_request Search Request
39146
+ * @param {*} [options] Override http request option.
39147
+ * @throws {RequiredError}
39148
+ * @memberof ConversationApiInterface
39149
+ */
39150
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
38925
39151
  /**
38926
39152
  * Insert a canned message
38927
39153
  * @summary Insert a canned message
@@ -39142,6 +39368,24 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
39142
39368
  * @memberof ConversationApi
39143
39369
  */
39144
39370
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
39371
+ /**
39372
+ * Retrieve a list of matching terms for a search field
39373
+ * @summary Retrieve a list of matching terms for a search field
39374
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
39375
+ * @param {*} [options] Override http request option.
39376
+ * @throws {RequiredError}
39377
+ * @memberof ConversationApi
39378
+ */
39379
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
39380
+ /**
39381
+ * Search conversations
39382
+ * @summary Search conversations
39383
+ * @param {ConversationSearchRequest} search_request Search Request
39384
+ * @param {*} [options] Override http request option.
39385
+ * @throws {RequiredError}
39386
+ * @memberof ConversationApi
39387
+ */
39388
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
39145
39389
  /**
39146
39390
  * Insert a canned message
39147
39391
  * @summary Insert a canned message
package/dist/api.js CHANGED
@@ -5954,6 +5954,102 @@ var ConversationApiFetchParamCreator = function (configuration) {
5954
5954
  options: localVarRequestOptions,
5955
5955
  };
5956
5956
  },
5957
+ /**
5958
+ * Retrieve a list of matching terms for a search field
5959
+ * @summary Retrieve a list of matching terms for a search field
5960
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
5961
+ * @param {*} [options] Override http request option.
5962
+ * @throws {RequiredError}
5963
+ */
5964
+ getConversationsAutocomplete: function (autocomplete_request, options) {
5965
+ if (options === void 0) { options = {}; }
5966
+ // verify required parameter 'autocomplete_request' is not null or undefined
5967
+ if (autocomplete_request === null || autocomplete_request === undefined) {
5968
+ throw new RequiredError('autocomplete_request', 'Required parameter autocomplete_request was null or undefined when calling getConversationsAutocomplete.');
5969
+ }
5970
+ var localVarPath = "/conversation/conversations/autocomplete";
5971
+ var localVarUrlObj = url.parse(localVarPath, true);
5972
+ var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
5973
+ var localVarHeaderParameter = {};
5974
+ var localVarQueryParameter = {};
5975
+ if (configuration && configuration.apiVersion) {
5976
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
5977
+ }
5978
+ // authentication ultraCartOauth required
5979
+ // oauth required
5980
+ if (configuration && configuration.accessToken) {
5981
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
5982
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
5983
+ : configuration.accessToken;
5984
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
5985
+ }
5986
+ // authentication ultraCartSimpleApiKey required
5987
+ if (configuration && configuration.apiKey) {
5988
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
5989
+ ? configuration.apiKey("x-ultracart-simple-key")
5990
+ : configuration.apiKey;
5991
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5992
+ }
5993
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5994
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
5995
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
5996
+ delete localVarUrlObj.search;
5997
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
5998
+ var needsSerialization = ("ConversationAutocompleteRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
5999
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(autocomplete_request || {}) : (autocomplete_request || "");
6000
+ return {
6001
+ url: url.format(localVarUrlObj),
6002
+ options: localVarRequestOptions,
6003
+ };
6004
+ },
6005
+ /**
6006
+ * Search conversations
6007
+ * @summary Search conversations
6008
+ * @param {ConversationSearchRequest} search_request Search Request
6009
+ * @param {*} [options] Override http request option.
6010
+ * @throws {RequiredError}
6011
+ */
6012
+ getConversationsSearch: function (search_request, options) {
6013
+ if (options === void 0) { options = {}; }
6014
+ // verify required parameter 'search_request' is not null or undefined
6015
+ if (search_request === null || search_request === undefined) {
6016
+ throw new RequiredError('search_request', 'Required parameter search_request was null or undefined when calling getConversationsSearch.');
6017
+ }
6018
+ var localVarPath = "/conversation/conversations/search";
6019
+ var localVarUrlObj = url.parse(localVarPath, true);
6020
+ var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
6021
+ var localVarHeaderParameter = {};
6022
+ var localVarQueryParameter = {};
6023
+ if (configuration && configuration.apiVersion) {
6024
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
6025
+ }
6026
+ // authentication ultraCartOauth required
6027
+ // oauth required
6028
+ if (configuration && configuration.accessToken) {
6029
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
6030
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
6031
+ : configuration.accessToken;
6032
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
6033
+ }
6034
+ // authentication ultraCartSimpleApiKey required
6035
+ if (configuration && configuration.apiKey) {
6036
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
6037
+ ? configuration.apiKey("x-ultracart-simple-key")
6038
+ : configuration.apiKey;
6039
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
6040
+ }
6041
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6042
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
6043
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
6044
+ delete localVarUrlObj.search;
6045
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
6046
+ var needsSerialization = ("ConversationSearchRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
6047
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(search_request || {}) : (search_request || "");
6048
+ return {
6049
+ url: url.format(localVarUrlObj),
6050
+ options: localVarRequestOptions,
6051
+ };
6052
+ },
5957
6053
  /**
5958
6054
  * Insert a canned message
5959
6055
  * @summary Insert a canned message
@@ -6803,6 +6899,50 @@ var ConversationApiFp = function (configuration) {
6803
6899
  });
6804
6900
  };
6805
6901
  },
6902
+ /**
6903
+ * Retrieve a list of matching terms for a search field
6904
+ * @summary Retrieve a list of matching terms for a search field
6905
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
6906
+ * @param {*} [options] Override http request option.
6907
+ * @throws {RequiredError}
6908
+ */
6909
+ getConversationsAutocomplete: function (autocomplete_request, options) {
6910
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationsAutocomplete(autocomplete_request, options);
6911
+ return function (fetch, basePath) {
6912
+ if (fetch === void 0) { fetch = portableFetch; }
6913
+ if (basePath === void 0) { basePath = BASE_PATH; }
6914
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
6915
+ if (response.status >= 200 && response.status < 300) {
6916
+ return response.json();
6917
+ }
6918
+ else {
6919
+ throw response;
6920
+ }
6921
+ });
6922
+ };
6923
+ },
6924
+ /**
6925
+ * Search conversations
6926
+ * @summary Search conversations
6927
+ * @param {ConversationSearchRequest} search_request Search Request
6928
+ * @param {*} [options] Override http request option.
6929
+ * @throws {RequiredError}
6930
+ */
6931
+ getConversationsSearch: function (search_request, options) {
6932
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationsSearch(search_request, options);
6933
+ return function (fetch, basePath) {
6934
+ if (fetch === void 0) { fetch = portableFetch; }
6935
+ if (basePath === void 0) { basePath = BASE_PATH; }
6936
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
6937
+ if (response.status >= 200 && response.status < 300) {
6938
+ return response.json();
6939
+ }
6940
+ else {
6941
+ throw response;
6942
+ }
6943
+ });
6944
+ };
6945
+ },
6806
6946
  /**
6807
6947
  * Insert a canned message
6808
6948
  * @summary Insert a canned message
@@ -7191,6 +7331,26 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
7191
7331
  getConversations: function (medium, before, _limit, _offset, options) {
7192
7332
  return (0, exports.ConversationApiFp)(configuration).getConversations(medium, before, _limit, _offset, options)(fetch, basePath);
7193
7333
  },
7334
+ /**
7335
+ * Retrieve a list of matching terms for a search field
7336
+ * @summary Retrieve a list of matching terms for a search field
7337
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
7338
+ * @param {*} [options] Override http request option.
7339
+ * @throws {RequiredError}
7340
+ */
7341
+ getConversationsAutocomplete: function (autocomplete_request, options) {
7342
+ return (0, exports.ConversationApiFp)(configuration).getConversationsAutocomplete(autocomplete_request, options)(fetch, basePath);
7343
+ },
7344
+ /**
7345
+ * Search conversations
7346
+ * @summary Search conversations
7347
+ * @param {ConversationSearchRequest} search_request Search Request
7348
+ * @param {*} [options] Override http request option.
7349
+ * @throws {RequiredError}
7350
+ */
7351
+ getConversationsSearch: function (search_request, options) {
7352
+ return (0, exports.ConversationApiFp)(configuration).getConversationsSearch(search_request, options)(fetch, basePath);
7353
+ },
7194
7354
  /**
7195
7355
  * Insert a canned message
7196
7356
  * @summary Insert a canned message
@@ -7451,6 +7611,28 @@ var ConversationApi = /** @class */ (function (_super) {
7451
7611
  ConversationApi.prototype.getConversations = function (medium, before, _limit, _offset, options) {
7452
7612
  return (0, exports.ConversationApiFp)(this.configuration).getConversations(medium, before, _limit, _offset, options)(this.fetch, this.basePath);
7453
7613
  };
7614
+ /**
7615
+ * Retrieve a list of matching terms for a search field
7616
+ * @summary Retrieve a list of matching terms for a search field
7617
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
7618
+ * @param {*} [options] Override http request option.
7619
+ * @throws {RequiredError}
7620
+ * @memberof ConversationApi
7621
+ */
7622
+ ConversationApi.prototype.getConversationsAutocomplete = function (autocomplete_request, options) {
7623
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationsAutocomplete(autocomplete_request, options)(this.fetch, this.basePath);
7624
+ };
7625
+ /**
7626
+ * Search conversations
7627
+ * @summary Search conversations
7628
+ * @param {ConversationSearchRequest} search_request Search Request
7629
+ * @param {*} [options] Override http request option.
7630
+ * @throws {RequiredError}
7631
+ * @memberof ConversationApi
7632
+ */
7633
+ ConversationApi.prototype.getConversationsSearch = function (search_request, options) {
7634
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationsSearch(search_request, options)(this.fetch, this.basePath);
7635
+ };
7454
7636
  /**
7455
7637
  * Insert a canned message
7456
7638
  * @summary Insert a canned message
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.80",
3
+ "version": "3.10.81",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [