ultracart_rest_api_v2_typescript 3.10.80 → 3.10.82

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.82
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.82 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.82 | 12/15/2022 | conversation search - added start date filtering |
58
+ | 3.10.81 | 12/15/2022 | conversation searching |
57
59
  | 3.10.80 | 12/13/2022 | conversations - add email and sms_phone to participant object |
58
60
  | 3.10.79 | 12/09/2022 | conversations - message translation |
59
61
  | 3.10.78 | 12/08/2022 | conversation canned messages |
package/api.ts CHANGED
@@ -6552,6 +6552,96 @@ 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<ConversationAutocompleteValue>}
6602
+ * @memberof ConversationAutocompleteResponse
6603
+ */
6604
+ results?: Array<ConversationAutocompleteValue>;
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
+
6625
+ /**
6626
+ *
6627
+ * @export
6628
+ * @interface ConversationAutocompleteValue
6629
+ */
6630
+ export interface ConversationAutocompleteValue {
6631
+ /**
6632
+ *
6633
+ * @type {string}
6634
+ * @memberof ConversationAutocompleteValue
6635
+ */
6636
+ description?: string;
6637
+ /**
6638
+ *
6639
+ * @type {string}
6640
+ * @memberof ConversationAutocompleteValue
6641
+ */
6642
+ value?: string;
6643
+ }
6644
+
6555
6645
  /**
6556
6646
  *
6557
6647
  * @export
@@ -7562,6 +7652,112 @@ export interface ConversationResponse {
7562
7652
  warning?: Warning;
7563
7653
  }
7564
7654
 
7655
+ /**
7656
+ *
7657
+ * @export
7658
+ * @interface ConversationSearchRequest
7659
+ */
7660
+ export interface ConversationSearchRequest {
7661
+ /**
7662
+ * End of the range
7663
+ * @type {string}
7664
+ * @memberof ConversationSearchRequest
7665
+ */
7666
+ date_end?: string;
7667
+ /**
7668
+ * Start of the range
7669
+ * @type {string}
7670
+ * @memberof ConversationSearchRequest
7671
+ */
7672
+ date_start?: string;
7673
+ /**
7674
+ *
7675
+ * @type {string}
7676
+ * @memberof ConversationSearchRequest
7677
+ */
7678
+ email_filter?: string;
7679
+ /**
7680
+ *
7681
+ * @type {string}
7682
+ * @memberof ConversationSearchRequest
7683
+ */
7684
+ language_filter?: string;
7685
+ /**
7686
+ *
7687
+ * @type {string}
7688
+ * @memberof ConversationSearchRequest
7689
+ */
7690
+ medium_filter?: string;
7691
+ /**
7692
+ *
7693
+ * @type {boolean}
7694
+ * @memberof ConversationSearchRequest
7695
+ */
7696
+ order_by_newest?: boolean;
7697
+ /**
7698
+ *
7699
+ * @type {boolean}
7700
+ * @memberof ConversationSearchRequest
7701
+ */
7702
+ order_by_oldest?: boolean;
7703
+ /**
7704
+ *
7705
+ * @type {number}
7706
+ * @memberof ConversationSearchRequest
7707
+ */
7708
+ range_begin?: number;
7709
+ /**
7710
+ *
7711
+ * @type {number}
7712
+ * @memberof ConversationSearchRequest
7713
+ */
7714
+ range_end?: number;
7715
+ /**
7716
+ *
7717
+ * @type {string}
7718
+ * @memberof ConversationSearchRequest
7719
+ */
7720
+ sms_phone_number_filter?: string;
7721
+ /**
7722
+ *
7723
+ * @type {string}
7724
+ * @memberof ConversationSearchRequest
7725
+ */
7726
+ text_search?: string;
7727
+ /**
7728
+ *
7729
+ * @type {boolean}
7730
+ * @memberof ConversationSearchRequest
7731
+ */
7732
+ visible_filter?: boolean;
7733
+ }
7734
+
7735
+ /**
7736
+ *
7737
+ * @export
7738
+ * @interface ConversationSearchResponse
7739
+ */
7740
+ export interface ConversationSearchResponse {
7741
+ /**
7742
+ *
7743
+ * @type {number}
7744
+ * @memberof ConversationSearchResponse
7745
+ */
7746
+ range_begin?: number;
7747
+ /**
7748
+ *
7749
+ * @type {number}
7750
+ * @memberof ConversationSearchResponse
7751
+ */
7752
+ range_end?: number;
7753
+ /**
7754
+ *
7755
+ * @type {number}
7756
+ * @memberof ConversationSearchResponse
7757
+ */
7758
+ total?: number;
7759
+ }
7760
+
7565
7761
  /**
7566
7762
  *
7567
7763
  * @export
@@ -42567,6 +42763,116 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
42567
42763
  options: localVarRequestOptions,
42568
42764
  };
42569
42765
  },
42766
+ /**
42767
+ * Retrieve a list of matching terms for a search field
42768
+ * @summary Retrieve a list of matching terms for a search field
42769
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
42770
+ * @param {*} [options] Override http request option.
42771
+ * @throws {RequiredError}
42772
+ */
42773
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options: any = {}): FetchArgs {
42774
+ // verify required parameter 'autocomplete_request' is not null or undefined
42775
+ if (autocomplete_request === null || autocomplete_request === undefined) {
42776
+ throw new RequiredError('autocomplete_request','Required parameter autocomplete_request was null or undefined when calling getConversationsAutocomplete.');
42777
+ }
42778
+ const localVarPath = `/conversation/conversations/autocomplete`;
42779
+ const localVarUrlObj = url.parse(localVarPath, true);
42780
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
42781
+ const localVarHeaderParameter = {} as any;
42782
+ const localVarQueryParameter = {} as any;
42783
+
42784
+ if(configuration && configuration.apiVersion) {
42785
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
42786
+ }
42787
+
42788
+
42789
+
42790
+ // authentication ultraCartOauth required
42791
+ // oauth required
42792
+ if (configuration && configuration.accessToken) {
42793
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
42794
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
42795
+ : configuration.accessToken;
42796
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
42797
+ }
42798
+
42799
+ // authentication ultraCartSimpleApiKey required
42800
+ if (configuration && configuration.apiKey) {
42801
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
42802
+ ? configuration.apiKey("x-ultracart-simple-key")
42803
+ : configuration.apiKey;
42804
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
42805
+ }
42806
+
42807
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42808
+
42809
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
42810
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
42811
+ delete localVarUrlObj.search;
42812
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
42813
+ const needsSerialization = (<any>"ConversationAutocompleteRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
42814
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(autocomplete_request || {}) : (autocomplete_request || "");
42815
+
42816
+ return {
42817
+ url: url.format(localVarUrlObj),
42818
+ options: localVarRequestOptions,
42819
+ };
42820
+ },
42821
+ /**
42822
+ * Search conversations
42823
+ * @summary Search conversations
42824
+ * @param {ConversationSearchRequest} search_request Search Request
42825
+ * @param {*} [options] Override http request option.
42826
+ * @throws {RequiredError}
42827
+ */
42828
+ getConversationsSearch(search_request: ConversationSearchRequest, options: any = {}): FetchArgs {
42829
+ // verify required parameter 'search_request' is not null or undefined
42830
+ if (search_request === null || search_request === undefined) {
42831
+ throw new RequiredError('search_request','Required parameter search_request was null or undefined when calling getConversationsSearch.');
42832
+ }
42833
+ const localVarPath = `/conversation/conversations/search`;
42834
+ const localVarUrlObj = url.parse(localVarPath, true);
42835
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
42836
+ const localVarHeaderParameter = {} as any;
42837
+ const localVarQueryParameter = {} as any;
42838
+
42839
+ if(configuration && configuration.apiVersion) {
42840
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
42841
+ }
42842
+
42843
+
42844
+
42845
+ // authentication ultraCartOauth required
42846
+ // oauth required
42847
+ if (configuration && configuration.accessToken) {
42848
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
42849
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
42850
+ : configuration.accessToken;
42851
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
42852
+ }
42853
+
42854
+ // authentication ultraCartSimpleApiKey required
42855
+ if (configuration && configuration.apiKey) {
42856
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
42857
+ ? configuration.apiKey("x-ultracart-simple-key")
42858
+ : configuration.apiKey;
42859
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
42860
+ }
42861
+
42862
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42863
+
42864
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
42865
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
42866
+ delete localVarUrlObj.search;
42867
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
42868
+ const needsSerialization = (<any>"ConversationSearchRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
42869
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(search_request || {}) : (search_request || "");
42870
+
42871
+ return {
42872
+ url: url.format(localVarUrlObj),
42873
+ options: localVarRequestOptions,
42874
+ };
42875
+ },
42570
42876
  /**
42571
42877
  * Insert a canned message
42572
42878
  * @summary Insert a canned message
@@ -43487,6 +43793,48 @@ export const ConversationApiFp = function(configuration?: Configuration) {
43487
43793
  });
43488
43794
  };
43489
43795
  },
43796
+ /**
43797
+ * Retrieve a list of matching terms for a search field
43798
+ * @summary Retrieve a list of matching terms for a search field
43799
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
43800
+ * @param {*} [options] Override http request option.
43801
+ * @throws {RequiredError}
43802
+ */
43803
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAutocompleteResponse> {
43804
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationsAutocomplete(autocomplete_request, options);
43805
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
43806
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
43807
+
43808
+ if (response.status >= 200 && response.status < 300) {
43809
+ return response.json();
43810
+
43811
+ } else {
43812
+ throw response;
43813
+ }
43814
+ });
43815
+ };
43816
+ },
43817
+ /**
43818
+ * Search conversations
43819
+ * @summary Search conversations
43820
+ * @param {ConversationSearchRequest} search_request Search Request
43821
+ * @param {*} [options] Override http request option.
43822
+ * @throws {RequiredError}
43823
+ */
43824
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationSearchResponse> {
43825
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationsSearch(search_request, options);
43826
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
43827
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
43828
+
43829
+ if (response.status >= 200 && response.status < 300) {
43830
+ return response.json();
43831
+
43832
+ } else {
43833
+ throw response;
43834
+ }
43835
+ });
43836
+ };
43837
+ },
43490
43838
  /**
43491
43839
  * Insert a canned message
43492
43840
  * @summary Insert a canned message
@@ -43863,6 +44211,26 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
43863
44211
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any) {
43864
44212
  return ConversationApiFp(configuration).getConversations(medium, before, _limit, _offset, options)(fetch, basePath);
43865
44213
  },
44214
+ /**
44215
+ * Retrieve a list of matching terms for a search field
44216
+ * @summary Retrieve a list of matching terms for a search field
44217
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44218
+ * @param {*} [options] Override http request option.
44219
+ * @throws {RequiredError}
44220
+ */
44221
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any) {
44222
+ return ConversationApiFp(configuration).getConversationsAutocomplete(autocomplete_request, options)(fetch, basePath);
44223
+ },
44224
+ /**
44225
+ * Search conversations
44226
+ * @summary Search conversations
44227
+ * @param {ConversationSearchRequest} search_request Search Request
44228
+ * @param {*} [options] Override http request option.
44229
+ * @throws {RequiredError}
44230
+ */
44231
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any) {
44232
+ return ConversationApiFp(configuration).getConversationsSearch(search_request, options)(fetch, basePath);
44233
+ },
43866
44234
  /**
43867
44235
  * Insert a canned message
43868
44236
  * @summary Insert a canned message
@@ -44107,6 +44475,26 @@ export interface ConversationApiInterface {
44107
44475
  */
44108
44476
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
44109
44477
 
44478
+ /**
44479
+ * Retrieve a list of matching terms for a search field
44480
+ * @summary Retrieve a list of matching terms for a search field
44481
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44482
+ * @param {*} [options] Override http request option.
44483
+ * @throws {RequiredError}
44484
+ * @memberof ConversationApiInterface
44485
+ */
44486
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
44487
+
44488
+ /**
44489
+ * Search conversations
44490
+ * @summary Search conversations
44491
+ * @param {ConversationSearchRequest} search_request Search Request
44492
+ * @param {*} [options] Override http request option.
44493
+ * @throws {RequiredError}
44494
+ * @memberof ConversationApiInterface
44495
+ */
44496
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
44497
+
44110
44498
  /**
44111
44499
  * Insert a canned message
44112
44500
  * @summary Insert a canned message
@@ -44373,6 +44761,30 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
44373
44761
  return ConversationApiFp(this.configuration).getConversations(medium, before, _limit, _offset, options)(this.fetch, this.basePath);
44374
44762
  }
44375
44763
 
44764
+ /**
44765
+ * Retrieve a list of matching terms for a search field
44766
+ * @summary Retrieve a list of matching terms for a search field
44767
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
44768
+ * @param {*} [options] Override http request option.
44769
+ * @throws {RequiredError}
44770
+ * @memberof ConversationApi
44771
+ */
44772
+ public getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any) {
44773
+ return ConversationApiFp(this.configuration).getConversationsAutocomplete(autocomplete_request, options)(this.fetch, this.basePath);
44774
+ }
44775
+
44776
+ /**
44777
+ * Search conversations
44778
+ * @summary Search conversations
44779
+ * @param {ConversationSearchRequest} search_request Search Request
44780
+ * @param {*} [options] Override http request option.
44781
+ * @throws {RequiredError}
44782
+ * @memberof ConversationApi
44783
+ */
44784
+ public getConversationsSearch(search_request: ConversationSearchRequest, options?: any) {
44785
+ return ConversationApiFp(this.configuration).getConversationsSearch(search_request, options)(this.fetch, this.basePath);
44786
+ }
44787
+
44376
44788
  /**
44377
44789
  * Insert a canned message
44378
44790
  * @summary Insert a canned message
package/dist/api.d.ts CHANGED
@@ -6400,6 +6400,93 @@ 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<ConversationAutocompleteValue>}
6449
+ * @memberof ConversationAutocompleteResponse
6450
+ */
6451
+ results?: Array<ConversationAutocompleteValue>;
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
+ }
6471
+ /**
6472
+ *
6473
+ * @export
6474
+ * @interface ConversationAutocompleteValue
6475
+ */
6476
+ export interface ConversationAutocompleteValue {
6477
+ /**
6478
+ *
6479
+ * @type {string}
6480
+ * @memberof ConversationAutocompleteValue
6481
+ */
6482
+ description?: string;
6483
+ /**
6484
+ *
6485
+ * @type {string}
6486
+ * @memberof ConversationAutocompleteValue
6487
+ */
6488
+ value?: string;
6489
+ }
6403
6490
  /**
6404
6491
  *
6405
6492
  * @export
@@ -7379,6 +7466,110 @@ export interface ConversationResponse {
7379
7466
  */
7380
7467
  warning?: Warning;
7381
7468
  }
7469
+ /**
7470
+ *
7471
+ * @export
7472
+ * @interface ConversationSearchRequest
7473
+ */
7474
+ export interface ConversationSearchRequest {
7475
+ /**
7476
+ * End of the range
7477
+ * @type {string}
7478
+ * @memberof ConversationSearchRequest
7479
+ */
7480
+ date_end?: string;
7481
+ /**
7482
+ * Start of the range
7483
+ * @type {string}
7484
+ * @memberof ConversationSearchRequest
7485
+ */
7486
+ date_start?: string;
7487
+ /**
7488
+ *
7489
+ * @type {string}
7490
+ * @memberof ConversationSearchRequest
7491
+ */
7492
+ email_filter?: string;
7493
+ /**
7494
+ *
7495
+ * @type {string}
7496
+ * @memberof ConversationSearchRequest
7497
+ */
7498
+ language_filter?: string;
7499
+ /**
7500
+ *
7501
+ * @type {string}
7502
+ * @memberof ConversationSearchRequest
7503
+ */
7504
+ medium_filter?: string;
7505
+ /**
7506
+ *
7507
+ * @type {boolean}
7508
+ * @memberof ConversationSearchRequest
7509
+ */
7510
+ order_by_newest?: boolean;
7511
+ /**
7512
+ *
7513
+ * @type {boolean}
7514
+ * @memberof ConversationSearchRequest
7515
+ */
7516
+ order_by_oldest?: boolean;
7517
+ /**
7518
+ *
7519
+ * @type {number}
7520
+ * @memberof ConversationSearchRequest
7521
+ */
7522
+ range_begin?: number;
7523
+ /**
7524
+ *
7525
+ * @type {number}
7526
+ * @memberof ConversationSearchRequest
7527
+ */
7528
+ range_end?: number;
7529
+ /**
7530
+ *
7531
+ * @type {string}
7532
+ * @memberof ConversationSearchRequest
7533
+ */
7534
+ sms_phone_number_filter?: string;
7535
+ /**
7536
+ *
7537
+ * @type {string}
7538
+ * @memberof ConversationSearchRequest
7539
+ */
7540
+ text_search?: string;
7541
+ /**
7542
+ *
7543
+ * @type {boolean}
7544
+ * @memberof ConversationSearchRequest
7545
+ */
7546
+ visible_filter?: boolean;
7547
+ }
7548
+ /**
7549
+ *
7550
+ * @export
7551
+ * @interface ConversationSearchResponse
7552
+ */
7553
+ export interface ConversationSearchResponse {
7554
+ /**
7555
+ *
7556
+ * @type {number}
7557
+ * @memberof ConversationSearchResponse
7558
+ */
7559
+ range_begin?: number;
7560
+ /**
7561
+ *
7562
+ * @type {number}
7563
+ * @memberof ConversationSearchResponse
7564
+ */
7565
+ range_end?: number;
7566
+ /**
7567
+ *
7568
+ * @type {number}
7569
+ * @memberof ConversationSearchResponse
7570
+ */
7571
+ total?: number;
7572
+ }
7382
7573
  /**
7383
7574
  *
7384
7575
  * @export
@@ -38325,6 +38516,22 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
38325
38516
  * @throws {RequiredError}
38326
38517
  */
38327
38518
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): FetchArgs;
38519
+ /**
38520
+ * Retrieve a list of matching terms for a search field
38521
+ * @summary Retrieve a list of matching terms for a search field
38522
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38523
+ * @param {*} [options] Override http request option.
38524
+ * @throws {RequiredError}
38525
+ */
38526
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): FetchArgs;
38527
+ /**
38528
+ * Search conversations
38529
+ * @summary Search conversations
38530
+ * @param {ConversationSearchRequest} search_request Search Request
38531
+ * @param {*} [options] Override http request option.
38532
+ * @throws {RequiredError}
38533
+ */
38534
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): FetchArgs;
38328
38535
  /**
38329
38536
  * Insert a canned message
38330
38537
  * @summary Insert a canned message
@@ -38520,6 +38727,22 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
38520
38727
  * @throws {RequiredError}
38521
38728
  */
38522
38729
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse>;
38730
+ /**
38731
+ * Retrieve a list of matching terms for a search field
38732
+ * @summary Retrieve a list of matching terms for a search field
38733
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38734
+ * @param {*} [options] Override http request option.
38735
+ * @throws {RequiredError}
38736
+ */
38737
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAutocompleteResponse>;
38738
+ /**
38739
+ * Search conversations
38740
+ * @summary Search conversations
38741
+ * @param {ConversationSearchRequest} search_request Search Request
38742
+ * @param {*} [options] Override http request option.
38743
+ * @throws {RequiredError}
38744
+ */
38745
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationSearchResponse>;
38523
38746
  /**
38524
38747
  * Insert a canned message
38525
38748
  * @summary Insert a canned message
@@ -38715,6 +38938,22 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
38715
38938
  * @throws {RequiredError}
38716
38939
  */
38717
38940
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
38941
+ /**
38942
+ * Retrieve a list of matching terms for a search field
38943
+ * @summary Retrieve a list of matching terms for a search field
38944
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
38945
+ * @param {*} [options] Override http request option.
38946
+ * @throws {RequiredError}
38947
+ */
38948
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
38949
+ /**
38950
+ * Search conversations
38951
+ * @summary Search conversations
38952
+ * @param {ConversationSearchRequest} search_request Search Request
38953
+ * @param {*} [options] Override http request option.
38954
+ * @throws {RequiredError}
38955
+ */
38956
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
38718
38957
  /**
38719
38958
  * Insert a canned message
38720
38959
  * @summary Insert a canned message
@@ -38922,6 +39161,24 @@ export interface ConversationApiInterface {
38922
39161
  * @memberof ConversationApiInterface
38923
39162
  */
38924
39163
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
39164
+ /**
39165
+ * Retrieve a list of matching terms for a search field
39166
+ * @summary Retrieve a list of matching terms for a search field
39167
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
39168
+ * @param {*} [options] Override http request option.
39169
+ * @throws {RequiredError}
39170
+ * @memberof ConversationApiInterface
39171
+ */
39172
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
39173
+ /**
39174
+ * Search conversations
39175
+ * @summary Search conversations
39176
+ * @param {ConversationSearchRequest} search_request Search Request
39177
+ * @param {*} [options] Override http request option.
39178
+ * @throws {RequiredError}
39179
+ * @memberof ConversationApiInterface
39180
+ */
39181
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
38925
39182
  /**
38926
39183
  * Insert a canned message
38927
39184
  * @summary Insert a canned message
@@ -39142,6 +39399,24 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
39142
39399
  * @memberof ConversationApi
39143
39400
  */
39144
39401
  getConversations(medium?: string, before?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
39402
+ /**
39403
+ * Retrieve a list of matching terms for a search field
39404
+ * @summary Retrieve a list of matching terms for a search field
39405
+ * @param {ConversationAutocompleteRequest} autocomplete_request Autocomplete Request
39406
+ * @param {*} [options] Override http request option.
39407
+ * @throws {RequiredError}
39408
+ * @memberof ConversationApi
39409
+ */
39410
+ getConversationsAutocomplete(autocomplete_request: ConversationAutocompleteRequest, options?: any): Promise<ConversationAutocompleteResponse>;
39411
+ /**
39412
+ * Search conversations
39413
+ * @summary Search conversations
39414
+ * @param {ConversationSearchRequest} search_request Search Request
39415
+ * @param {*} [options] Override http request option.
39416
+ * @throws {RequiredError}
39417
+ * @memberof ConversationApi
39418
+ */
39419
+ getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
39145
39420
  /**
39146
39421
  * Insert a canned message
39147
39422
  * @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.82",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [