ultracart_rest_api_v2_typescript 3.10.116 → 3.10.118

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.116
1
+ ## ultracart_rest_api_v2_typescript@3.10.118
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.116 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.118 --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.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
58
+ | 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
57
59
  | 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
58
60
  | 3.10.115 | 02/07/2023 | convo - new event for when a customer joins a queue |
59
61
  | 3.10.114 | 02/07/2023 | convo - new event for when a customer joins a queue |
package/api.ts CHANGED
@@ -2628,6 +2628,12 @@ export interface CartCheckout {
2628
2628
  * @memberof CartCheckout
2629
2629
  */
2630
2630
  custom_field1?: string;
2631
+ /**
2632
+ * Custom field 10
2633
+ * @type {string}
2634
+ * @memberof CartCheckout
2635
+ */
2636
+ custom_field10?: string;
2631
2637
  /**
2632
2638
  * Custom field 2
2633
2639
  * @type {string}
@@ -2664,6 +2670,18 @@ export interface CartCheckout {
2664
2670
  * @memberof CartCheckout
2665
2671
  */
2666
2672
  custom_field7?: string;
2673
+ /**
2674
+ * Custom field 8
2675
+ * @type {string}
2676
+ * @memberof CartCheckout
2677
+ */
2678
+ custom_field8?: string;
2679
+ /**
2680
+ * Custom field 9
2681
+ * @type {string}
2682
+ * @memberof CartCheckout
2683
+ */
2684
+ custom_field9?: string;
2667
2685
  /**
2668
2686
  * IP Address (read only unless non-browser key authenticated)
2669
2687
  * @type {string}
@@ -28327,6 +28345,12 @@ export interface Order {
28327
28345
  * @memberof Order
28328
28346
  */
28329
28347
  taxes?: OrderTaxes;
28348
+ /**
28349
+ * UTM clicks. The zero index is the most recent (last) UTM click
28350
+ * @type {Array<OrderUtm>}
28351
+ * @memberof Order
28352
+ */
28353
+ utms?: Array<OrderUtm>;
28330
28354
  }
28331
28355
 
28332
28356
  /**
@@ -28877,6 +28901,12 @@ export interface OrderCheckout {
28877
28901
  * @memberof OrderCheckout
28878
28902
  */
28879
28903
  custom_field1?: string;
28904
+ /**
28905
+ * Custom field 10
28906
+ * @type {string}
28907
+ * @memberof OrderCheckout
28908
+ */
28909
+ custom_field10?: string;
28880
28910
  /**
28881
28911
  * Custom field 2
28882
28912
  * @type {string}
@@ -28913,6 +28943,18 @@ export interface OrderCheckout {
28913
28943
  * @memberof OrderCheckout
28914
28944
  */
28915
28945
  custom_field7?: string;
28946
+ /**
28947
+ * Custom field 8
28948
+ * @type {string}
28949
+ * @memberof OrderCheckout
28950
+ */
28951
+ custom_field8?: string;
28952
+ /**
28953
+ * Custom field 9
28954
+ * @type {string}
28955
+ * @memberof OrderCheckout
28956
+ */
28957
+ custom_field9?: string;
28916
28958
  /**
28917
28959
  * IP address of the customer when placing the order
28918
28960
  * @type {string}
@@ -32163,6 +32205,158 @@ export interface OrderTransactionalMerchantNote {
32163
32205
  user?: string;
32164
32206
  }
32165
32207
 
32208
+ /**
32209
+ *
32210
+ * @export
32211
+ * @interface OrderUtm
32212
+ */
32213
+ export interface OrderUtm {
32214
+ /**
32215
+ *
32216
+ * @type {number}
32217
+ * @memberof OrderUtm
32218
+ */
32219
+ attribution_first_click_subtotal?: number;
32220
+ /**
32221
+ *
32222
+ * @type {number}
32223
+ * @memberof OrderUtm
32224
+ */
32225
+ attribution_first_click_total?: number;
32226
+ /**
32227
+ *
32228
+ * @type {number}
32229
+ * @memberof OrderUtm
32230
+ */
32231
+ attribution_last_click_subtotal?: number;
32232
+ /**
32233
+ *
32234
+ * @type {number}
32235
+ * @memberof OrderUtm
32236
+ */
32237
+ attribution_last_click_total?: number;
32238
+ /**
32239
+ *
32240
+ * @type {number}
32241
+ * @memberof OrderUtm
32242
+ */
32243
+ attribution_linear_subtotal?: number;
32244
+ /**
32245
+ *
32246
+ * @type {number}
32247
+ * @memberof OrderUtm
32248
+ */
32249
+ attribution_linear_total?: number;
32250
+ /**
32251
+ *
32252
+ * @type {number}
32253
+ * @memberof OrderUtm
32254
+ */
32255
+ attribution_position_based_subtotal?: number;
32256
+ /**
32257
+ *
32258
+ * @type {number}
32259
+ * @memberof OrderUtm
32260
+ */
32261
+ attribution_position_based_total?: number;
32262
+ /**
32263
+ * Date/time that the click happened
32264
+ * @type {string}
32265
+ * @memberof OrderUtm
32266
+ */
32267
+ click_dts?: string;
32268
+ /**
32269
+ *
32270
+ * @type {string}
32271
+ * @memberof OrderUtm
32272
+ */
32273
+ facebook_ad_id?: string;
32274
+ /**
32275
+ *
32276
+ * @type {string}
32277
+ * @memberof OrderUtm
32278
+ */
32279
+ fbclid?: string;
32280
+ /**
32281
+ *
32282
+ * @type {string}
32283
+ * @memberof OrderUtm
32284
+ */
32285
+ gbraid?: string;
32286
+ /**
32287
+ *
32288
+ * @type {string}
32289
+ * @memberof OrderUtm
32290
+ */
32291
+ glcid?: string;
32292
+ /**
32293
+ *
32294
+ * @type {string}
32295
+ * @memberof OrderUtm
32296
+ */
32297
+ msclkid?: string;
32298
+ /**
32299
+ *
32300
+ * @type {string}
32301
+ * @memberof OrderUtm
32302
+ */
32303
+ ttclid?: string;
32304
+ /**
32305
+ *
32306
+ * @type {string}
32307
+ * @memberof OrderUtm
32308
+ */
32309
+ uc_message_id?: string;
32310
+ /**
32311
+ *
32312
+ * @type {string}
32313
+ * @memberof OrderUtm
32314
+ */
32315
+ utm_campaign?: string;
32316
+ /**
32317
+ *
32318
+ * @type {string}
32319
+ * @memberof OrderUtm
32320
+ */
32321
+ utm_content?: string;
32322
+ /**
32323
+ *
32324
+ * @type {string}
32325
+ * @memberof OrderUtm
32326
+ */
32327
+ utm_id?: string;
32328
+ /**
32329
+ *
32330
+ * @type {string}
32331
+ * @memberof OrderUtm
32332
+ */
32333
+ utm_medium?: string;
32334
+ /**
32335
+ *
32336
+ * @type {string}
32337
+ * @memberof OrderUtm
32338
+ */
32339
+ utm_source?: string;
32340
+ /**
32341
+ *
32342
+ * @type {string}
32343
+ * @memberof OrderUtm
32344
+ */
32345
+ utm_term?: string;
32346
+ /**
32347
+ *
32348
+ * @type {string}
32349
+ * @memberof OrderUtm
32350
+ */
32351
+ vmcid?: string;
32352
+ /**
32353
+ *
32354
+ * @type {string}
32355
+ * @memberof OrderUtm
32356
+ */
32357
+ wbraid?: string;
32358
+ }
32359
+
32166
32360
  /**
32167
32361
  *
32168
32362
  * @export
@@ -32571,6 +32765,12 @@ export interface PricingTier {
32571
32765
  * @memberof PricingTier
32572
32766
  */
32573
32767
  realtime_percentage_discount?: number;
32768
+ /**
32769
+ * Restrict inventory to this distribution center oid
32770
+ * @type {number}
32771
+ * @memberof PricingTier
32772
+ */
32773
+ restrict_to_distribution_center_oid?: number;
32574
32774
  /**
32575
32775
  *
32576
32776
  * @type {PricingTierNotification}
@@ -45529,6 +45729,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
45529
45729
  options: localVarRequestOptions,
45530
45730
  };
45531
45731
  },
45732
+ /**
45733
+ * Unsubscribe any SMS participants in this conversation
45734
+ * @summary Unsubscribe any SMS participants in this conversation
45735
+ * @param {string} conversation_uuid
45736
+ * @param {*} [options] Override http request option.
45737
+ * @throws {RequiredError}
45738
+ */
45739
+ smsUnsubscribeConversation(conversation_uuid: string, options: any = {}): FetchArgs {
45740
+ // verify required parameter 'conversation_uuid' is not null or undefined
45741
+ if (conversation_uuid === null || conversation_uuid === undefined) {
45742
+ throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling smsUnsubscribeConversation.');
45743
+ }
45744
+ const localVarPath = `/conversation/conversations/{conversation_uuid}/sms_unsubscribe`
45745
+ .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
45746
+ const localVarUrlObj = url.parse(localVarPath, true);
45747
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
45748
+ const localVarHeaderParameter = {} as any;
45749
+ const localVarQueryParameter = {} as any;
45750
+
45751
+ if(configuration && configuration.apiVersion) {
45752
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
45753
+ }
45754
+
45755
+
45756
+
45757
+ // authentication ultraCartOauth required
45758
+ // oauth required
45759
+ if (configuration && configuration.accessToken) {
45760
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
45761
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
45762
+ : configuration.accessToken;
45763
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
45764
+ }
45765
+
45766
+ // authentication ultraCartSimpleApiKey required
45767
+ if (configuration && configuration.apiKey) {
45768
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
45769
+ ? configuration.apiKey("x-ultracart-simple-key")
45770
+ : configuration.apiKey;
45771
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
45772
+ }
45773
+
45774
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
45775
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
45776
+ delete localVarUrlObj.search;
45777
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
45778
+
45779
+ return {
45780
+ url: url.format(localVarUrlObj),
45781
+ options: localVarRequestOptions,
45782
+ };
45783
+ },
45532
45784
  /**
45533
45785
  * Start a new conversation
45534
45786
  * @summary Start a conversation
@@ -46477,6 +46729,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
46477
46729
  });
46478
46730
  };
46479
46731
  },
46732
+ /**
46733
+ * Unsubscribe any SMS participants in this conversation
46734
+ * @summary Unsubscribe any SMS participants in this conversation
46735
+ * @param {string} conversation_uuid
46736
+ * @param {*} [options] Override http request option.
46737
+ * @throws {RequiredError}
46738
+ */
46739
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
46740
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).smsUnsubscribeConversation(conversation_uuid, options);
46741
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
46742
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
46743
+
46744
+ if (response.status >= 200 && response.status < 300) {
46745
+ return response;
46746
+
46747
+ } else {
46748
+ throw response;
46749
+ }
46750
+ });
46751
+ };
46752
+ },
46480
46753
  /**
46481
46754
  * Start a new conversation
46482
46755
  * @summary Start a conversation
@@ -46893,6 +47166,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
46893
47166
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any) {
46894
47167
  return ConversationApiFp(configuration).searchConversationCannedMessages(search_request, options)(fetch, basePath);
46895
47168
  },
47169
+ /**
47170
+ * Unsubscribe any SMS participants in this conversation
47171
+ * @summary Unsubscribe any SMS participants in this conversation
47172
+ * @param {string} conversation_uuid
47173
+ * @param {*} [options] Override http request option.
47174
+ * @throws {RequiredError}
47175
+ */
47176
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any) {
47177
+ return ConversationApiFp(configuration).smsUnsubscribeConversation(conversation_uuid, options)(fetch, basePath);
47178
+ },
46896
47179
  /**
46897
47180
  * Start a new conversation
46898
47181
  * @summary Start a conversation
@@ -47243,6 +47526,16 @@ export interface ConversationApiInterface {
47243
47526
  */
47244
47527
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
47245
47528
 
47529
+ /**
47530
+ * Unsubscribe any SMS participants in this conversation
47531
+ * @summary Unsubscribe any SMS participants in this conversation
47532
+ * @param {string} conversation_uuid
47533
+ * @param {*} [options] Override http request option.
47534
+ * @throws {RequiredError}
47535
+ * @memberof ConversationApiInterface
47536
+ */
47537
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<{}>;
47538
+
47246
47539
  /**
47247
47540
  * Start a new conversation
47248
47541
  * @summary Start a conversation
@@ -47649,6 +47942,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
47649
47942
  return ConversationApiFp(this.configuration).searchConversationCannedMessages(search_request, options)(this.fetch, this.basePath);
47650
47943
  }
47651
47944
 
47945
+ /**
47946
+ * Unsubscribe any SMS participants in this conversation
47947
+ * @summary Unsubscribe any SMS participants in this conversation
47948
+ * @param {string} conversation_uuid
47949
+ * @param {*} [options] Override http request option.
47950
+ * @throws {RequiredError}
47951
+ * @memberof ConversationApi
47952
+ */
47953
+ public smsUnsubscribeConversation(conversation_uuid: string, options?: any) {
47954
+ return ConversationApiFp(this.configuration).smsUnsubscribeConversation(conversation_uuid, options)(this.fetch, this.basePath);
47955
+ }
47956
+
47652
47957
  /**
47653
47958
  * Start a new conversation
47654
47959
  * @summary Start a conversation
package/dist/api.d.ts CHANGED
@@ -2561,6 +2561,12 @@ export interface CartCheckout {
2561
2561
  * @memberof CartCheckout
2562
2562
  */
2563
2563
  custom_field1?: string;
2564
+ /**
2565
+ * Custom field 10
2566
+ * @type {string}
2567
+ * @memberof CartCheckout
2568
+ */
2569
+ custom_field10?: string;
2564
2570
  /**
2565
2571
  * Custom field 2
2566
2572
  * @type {string}
@@ -2597,6 +2603,18 @@ export interface CartCheckout {
2597
2603
  * @memberof CartCheckout
2598
2604
  */
2599
2605
  custom_field7?: string;
2606
+ /**
2607
+ * Custom field 8
2608
+ * @type {string}
2609
+ * @memberof CartCheckout
2610
+ */
2611
+ custom_field8?: string;
2612
+ /**
2613
+ * Custom field 9
2614
+ * @type {string}
2615
+ * @memberof CartCheckout
2616
+ */
2617
+ custom_field9?: string;
2600
2618
  /**
2601
2619
  * IP Address (read only unless non-browser key authenticated)
2602
2620
  * @type {string}
@@ -27723,6 +27741,12 @@ export interface Order {
27723
27741
  * @memberof Order
27724
27742
  */
27725
27743
  taxes?: OrderTaxes;
27744
+ /**
27745
+ * UTM clicks. The zero index is the most recent (last) UTM click
27746
+ * @type {Array<OrderUtm>}
27747
+ * @memberof Order
27748
+ */
27749
+ utms?: Array<OrderUtm>;
27726
27750
  }
27727
27751
  /**
27728
27752
  * @export
@@ -28262,6 +28286,12 @@ export interface OrderCheckout {
28262
28286
  * @memberof OrderCheckout
28263
28287
  */
28264
28288
  custom_field1?: string;
28289
+ /**
28290
+ * Custom field 10
28291
+ * @type {string}
28292
+ * @memberof OrderCheckout
28293
+ */
28294
+ custom_field10?: string;
28265
28295
  /**
28266
28296
  * Custom field 2
28267
28297
  * @type {string}
@@ -28298,6 +28328,18 @@ export interface OrderCheckout {
28298
28328
  * @memberof OrderCheckout
28299
28329
  */
28300
28330
  custom_field7?: string;
28331
+ /**
28332
+ * Custom field 8
28333
+ * @type {string}
28334
+ * @memberof OrderCheckout
28335
+ */
28336
+ custom_field8?: string;
28337
+ /**
28338
+ * Custom field 9
28339
+ * @type {string}
28340
+ * @memberof OrderCheckout
28341
+ */
28342
+ custom_field9?: string;
28301
28343
  /**
28302
28344
  * IP address of the customer when placing the order
28303
28345
  * @type {string}
@@ -31488,6 +31530,157 @@ export interface OrderTransactionalMerchantNote {
31488
31530
  */
31489
31531
  user?: string;
31490
31532
  }
31533
+ /**
31534
+ *
31535
+ * @export
31536
+ * @interface OrderUtm
31537
+ */
31538
+ export interface OrderUtm {
31539
+ /**
31540
+ *
31541
+ * @type {number}
31542
+ * @memberof OrderUtm
31543
+ */
31544
+ attribution_first_click_subtotal?: number;
31545
+ /**
31546
+ *
31547
+ * @type {number}
31548
+ * @memberof OrderUtm
31549
+ */
31550
+ attribution_first_click_total?: number;
31551
+ /**
31552
+ *
31553
+ * @type {number}
31554
+ * @memberof OrderUtm
31555
+ */
31556
+ attribution_last_click_subtotal?: number;
31557
+ /**
31558
+ *
31559
+ * @type {number}
31560
+ * @memberof OrderUtm
31561
+ */
31562
+ attribution_last_click_total?: number;
31563
+ /**
31564
+ *
31565
+ * @type {number}
31566
+ * @memberof OrderUtm
31567
+ */
31568
+ attribution_linear_subtotal?: number;
31569
+ /**
31570
+ *
31571
+ * @type {number}
31572
+ * @memberof OrderUtm
31573
+ */
31574
+ attribution_linear_total?: number;
31575
+ /**
31576
+ *
31577
+ * @type {number}
31578
+ * @memberof OrderUtm
31579
+ */
31580
+ attribution_position_based_subtotal?: number;
31581
+ /**
31582
+ *
31583
+ * @type {number}
31584
+ * @memberof OrderUtm
31585
+ */
31586
+ attribution_position_based_total?: number;
31587
+ /**
31588
+ * Date/time that the click happened
31589
+ * @type {string}
31590
+ * @memberof OrderUtm
31591
+ */
31592
+ click_dts?: string;
31593
+ /**
31594
+ *
31595
+ * @type {string}
31596
+ * @memberof OrderUtm
31597
+ */
31598
+ facebook_ad_id?: string;
31599
+ /**
31600
+ *
31601
+ * @type {string}
31602
+ * @memberof OrderUtm
31603
+ */
31604
+ fbclid?: string;
31605
+ /**
31606
+ *
31607
+ * @type {string}
31608
+ * @memberof OrderUtm
31609
+ */
31610
+ gbraid?: string;
31611
+ /**
31612
+ *
31613
+ * @type {string}
31614
+ * @memberof OrderUtm
31615
+ */
31616
+ glcid?: string;
31617
+ /**
31618
+ *
31619
+ * @type {string}
31620
+ * @memberof OrderUtm
31621
+ */
31622
+ msclkid?: string;
31623
+ /**
31624
+ *
31625
+ * @type {string}
31626
+ * @memberof OrderUtm
31627
+ */
31628
+ ttclid?: string;
31629
+ /**
31630
+ *
31631
+ * @type {string}
31632
+ * @memberof OrderUtm
31633
+ */
31634
+ uc_message_id?: string;
31635
+ /**
31636
+ *
31637
+ * @type {string}
31638
+ * @memberof OrderUtm
31639
+ */
31640
+ utm_campaign?: string;
31641
+ /**
31642
+ *
31643
+ * @type {string}
31644
+ * @memberof OrderUtm
31645
+ */
31646
+ utm_content?: string;
31647
+ /**
31648
+ *
31649
+ * @type {string}
31650
+ * @memberof OrderUtm
31651
+ */
31652
+ utm_id?: string;
31653
+ /**
31654
+ *
31655
+ * @type {string}
31656
+ * @memberof OrderUtm
31657
+ */
31658
+ utm_medium?: string;
31659
+ /**
31660
+ *
31661
+ * @type {string}
31662
+ * @memberof OrderUtm
31663
+ */
31664
+ utm_source?: string;
31665
+ /**
31666
+ *
31667
+ * @type {string}
31668
+ * @memberof OrderUtm
31669
+ */
31670
+ utm_term?: string;
31671
+ /**
31672
+ *
31673
+ * @type {string}
31674
+ * @memberof OrderUtm
31675
+ */
31676
+ vmcid?: string;
31677
+ /**
31678
+ *
31679
+ * @type {string}
31680
+ * @memberof OrderUtm
31681
+ */
31682
+ wbraid?: string;
31683
+ }
31491
31684
  /**
31492
31685
  *
31493
31686
  * @export
@@ -31890,6 +32083,12 @@ export interface PricingTier {
31890
32083
  * @memberof PricingTier
31891
32084
  */
31892
32085
  realtime_percentage_discount?: number;
32086
+ /**
32087
+ * Restrict inventory to this distribution center oid
32088
+ * @type {number}
32089
+ * @memberof PricingTier
32090
+ */
32091
+ restrict_to_distribution_center_oid?: number;
31893
32092
  /**
31894
32093
  *
31895
32094
  * @type {PricingTierNotification}
@@ -40098,6 +40297,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
40098
40297
  * @throws {RequiredError}
40099
40298
  */
40100
40299
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): FetchArgs;
40300
+ /**
40301
+ * Unsubscribe any SMS participants in this conversation
40302
+ * @summary Unsubscribe any SMS participants in this conversation
40303
+ * @param {string} conversation_uuid
40304
+ * @param {*} [options] Override http request option.
40305
+ * @throws {RequiredError}
40306
+ */
40307
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): FetchArgs;
40101
40308
  /**
40102
40309
  * Start a new conversation
40103
40310
  * @summary Start a conversation
@@ -40377,6 +40584,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
40377
40584
  * @throws {RequiredError}
40378
40585
  */
40379
40586
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationCannedMessagesResponse>;
40587
+ /**
40588
+ * Unsubscribe any SMS participants in this conversation
40589
+ * @summary Unsubscribe any SMS participants in this conversation
40590
+ * @param {string} conversation_uuid
40591
+ * @param {*} [options] Override http request option.
40592
+ * @throws {RequiredError}
40593
+ */
40594
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
40380
40595
  /**
40381
40596
  * Start a new conversation
40382
40597
  * @summary Start a conversation
@@ -40656,6 +40871,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
40656
40871
  * @throws {RequiredError}
40657
40872
  */
40658
40873
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
40874
+ /**
40875
+ * Unsubscribe any SMS participants in this conversation
40876
+ * @summary Unsubscribe any SMS participants in this conversation
40877
+ * @param {string} conversation_uuid
40878
+ * @param {*} [options] Override http request option.
40879
+ * @throws {RequiredError}
40880
+ */
40881
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<Response>;
40659
40882
  /**
40660
40883
  * Start a new conversation
40661
40884
  * @summary Start a conversation
@@ -40964,6 +41187,15 @@ export interface ConversationApiInterface {
40964
41187
  * @memberof ConversationApiInterface
40965
41188
  */
40966
41189
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
41190
+ /**
41191
+ * Unsubscribe any SMS participants in this conversation
41192
+ * @summary Unsubscribe any SMS participants in this conversation
41193
+ * @param {string} conversation_uuid
41194
+ * @param {*} [options] Override http request option.
41195
+ * @throws {RequiredError}
41196
+ * @memberof ConversationApiInterface
41197
+ */
41198
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<{}>;
40967
41199
  /**
40968
41200
  * Start a new conversation
40969
41201
  * @summary Start a conversation
@@ -41279,6 +41511,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
41279
41511
  * @memberof ConversationApi
41280
41512
  */
41281
41513
  searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
41514
+ /**
41515
+ * Unsubscribe any SMS participants in this conversation
41516
+ * @summary Unsubscribe any SMS participants in this conversation
41517
+ * @param {string} conversation_uuid
41518
+ * @param {*} [options] Override http request option.
41519
+ * @throws {RequiredError}
41520
+ * @memberof ConversationApi
41521
+ */
41522
+ smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<Response>;
41282
41523
  /**
41283
41524
  * Start a new conversation
41284
41525
  * @summary Start a conversation
package/dist/api.js CHANGED
@@ -7441,6 +7441,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
7441
7441
  options: localVarRequestOptions,
7442
7442
  };
7443
7443
  },
7444
+ /**
7445
+ * Unsubscribe any SMS participants in this conversation
7446
+ * @summary Unsubscribe any SMS participants in this conversation
7447
+ * @param {string} conversation_uuid
7448
+ * @param {*} [options] Override http request option.
7449
+ * @throws {RequiredError}
7450
+ */
7451
+ smsUnsubscribeConversation: function (conversation_uuid, options) {
7452
+ if (options === void 0) { options = {}; }
7453
+ // verify required parameter 'conversation_uuid' is not null or undefined
7454
+ if (conversation_uuid === null || conversation_uuid === undefined) {
7455
+ throw new RequiredError('conversation_uuid', 'Required parameter conversation_uuid was null or undefined when calling smsUnsubscribeConversation.');
7456
+ }
7457
+ var localVarPath = "/conversation/conversations/{conversation_uuid}/sms_unsubscribe"
7458
+ .replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(conversation_uuid)));
7459
+ var localVarUrlObj = url.parse(localVarPath, true);
7460
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
7461
+ var localVarHeaderParameter = {};
7462
+ var localVarQueryParameter = {};
7463
+ if (configuration && configuration.apiVersion) {
7464
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
7465
+ }
7466
+ // authentication ultraCartOauth required
7467
+ // oauth required
7468
+ if (configuration && configuration.accessToken) {
7469
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
7470
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
7471
+ : configuration.accessToken;
7472
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
7473
+ }
7474
+ // authentication ultraCartSimpleApiKey required
7475
+ if (configuration && configuration.apiKey) {
7476
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
7477
+ ? configuration.apiKey("x-ultracart-simple-key")
7478
+ : configuration.apiKey;
7479
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
7480
+ }
7481
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
7482
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
7483
+ delete localVarUrlObj.search;
7484
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
7485
+ return {
7486
+ url: url.format(localVarUrlObj),
7487
+ options: localVarRequestOptions,
7488
+ };
7489
+ },
7444
7490
  /**
7445
7491
  * Start a new conversation
7446
7492
  * @summary Start a conversation
@@ -8375,6 +8421,28 @@ var ConversationApiFp = function (configuration) {
8375
8421
  });
8376
8422
  };
8377
8423
  },
8424
+ /**
8425
+ * Unsubscribe any SMS participants in this conversation
8426
+ * @summary Unsubscribe any SMS participants in this conversation
8427
+ * @param {string} conversation_uuid
8428
+ * @param {*} [options] Override http request option.
8429
+ * @throws {RequiredError}
8430
+ */
8431
+ smsUnsubscribeConversation: function (conversation_uuid, options) {
8432
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).smsUnsubscribeConversation(conversation_uuid, options);
8433
+ return function (fetch, basePath) {
8434
+ if (fetch === void 0) { fetch = portableFetch; }
8435
+ if (basePath === void 0) { basePath = BASE_PATH; }
8436
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
8437
+ if (response.status >= 200 && response.status < 300) {
8438
+ return response;
8439
+ }
8440
+ else {
8441
+ throw response;
8442
+ }
8443
+ });
8444
+ };
8445
+ },
8378
8446
  /**
8379
8447
  * Start a new conversation
8380
8448
  * @summary Start a conversation
@@ -8797,6 +8865,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
8797
8865
  searchConversationCannedMessages: function (search_request, options) {
8798
8866
  return (0, exports.ConversationApiFp)(configuration).searchConversationCannedMessages(search_request, options)(fetch, basePath);
8799
8867
  },
8868
+ /**
8869
+ * Unsubscribe any SMS participants in this conversation
8870
+ * @summary Unsubscribe any SMS participants in this conversation
8871
+ * @param {string} conversation_uuid
8872
+ * @param {*} [options] Override http request option.
8873
+ * @throws {RequiredError}
8874
+ */
8875
+ smsUnsubscribeConversation: function (conversation_uuid, options) {
8876
+ return (0, exports.ConversationApiFp)(configuration).smsUnsubscribeConversation(conversation_uuid, options)(fetch, basePath);
8877
+ },
8800
8878
  /**
8801
8879
  * Start a new conversation
8802
8880
  * @summary Start a conversation
@@ -9180,6 +9258,17 @@ var ConversationApi = /** @class */ (function (_super) {
9180
9258
  ConversationApi.prototype.searchConversationCannedMessages = function (search_request, options) {
9181
9259
  return (0, exports.ConversationApiFp)(this.configuration).searchConversationCannedMessages(search_request, options)(this.fetch, this.basePath);
9182
9260
  };
9261
+ /**
9262
+ * Unsubscribe any SMS participants in this conversation
9263
+ * @summary Unsubscribe any SMS participants in this conversation
9264
+ * @param {string} conversation_uuid
9265
+ * @param {*} [options] Override http request option.
9266
+ * @throws {RequiredError}
9267
+ * @memberof ConversationApi
9268
+ */
9269
+ ConversationApi.prototype.smsUnsubscribeConversation = function (conversation_uuid, options) {
9270
+ return (0, exports.ConversationApiFp)(this.configuration).smsUnsubscribeConversation(conversation_uuid, options)(this.fetch, this.basePath);
9271
+ };
9183
9272
  /**
9184
9273
  * Start a new conversation
9185
9274
  * @summary Start a conversation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.116",
3
+ "version": "3.10.118",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [