ultracart_api 4.0.110.rc → 4.0.112.rc

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 55ed4d64dd1436752aebe59d5a83206ad26640b1ed9b289d84214c7b2029dc3e
4
- data.tar.gz: 619a9eb800741cff9bed0c698713d796e3f8a71dd6a4f189f959c3f640be910b
3
+ metadata.gz: 6f038e5716ab2e24df8c85440e2f5fbdecb61a8636e6215ce297cd440f526e92
4
+ data.tar.gz: 101cfafc4ffd74232b24dc787d4efd0603124d1b3aeac5789353ed6d9fd9bd19
5
5
  SHA512:
6
- metadata.gz: 14c6f279b301e579e552f653e37c350356b41eba1754e683cc4ae47a244e57b990dc5343c9ff5e567143fe86f5f26c836a89b9d3c5062b0ddc00f58a29d10a2c
7
- data.tar.gz: 96110747debb83eb4115a34e927d33df44d4c606246e583193f485c1c13774d9224e4ea6be249f10395b5d576e0152c6c9bc7ad36ce77783768c67f4d850df76
6
+ metadata.gz: 5d6b708a6711e0d5f343d2797d6815fcba52e106411d9f62a26b5625cfbcf063d1589eb9a14fbc09d56cc1b6625dfaa7386b1bf1f6b9a0f38b1b7d0a4ef58d68
7
+ data.tar.gz: fc3d2339f4bcdd8cfc269c0e09ea4c43ede45eced6a17ef5753eff15f2df63a9bc2c8c8b81ccce225c86f0bc48a342ceaee2168f2563b0a856ef498d41fc8e92
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.0.110.rc
10
+ - Package version: 4.0.112.rc
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.110.rc.gem
27
+ gem install ./ultracart_api-4.0.112.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.110.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.112.rc.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.110.rc'
36
+ gem 'ultracart_api', '~> 4.0.112.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -104,9 +104,15 @@ Class | Method | HTTP request | Description
104
104
  *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
105
105
  *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
106
106
  *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
107
+ *UltracartClient::ChannelPartnerApi* | [**delete_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
107
108
  *UltracartClient::ChannelPartnerApi* | [**estimate_shipping_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
108
109
  *UltracartClient::ChannelPartnerApi* | [**estimate_tax_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
110
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id.
111
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preferences**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner.
112
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partners**](docs/ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
109
113
  *UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
114
+ *UltracartClient::ChannelPartnerApi* | [**insert_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
115
+ *UltracartClient::ChannelPartnerApi* | [**update_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
110
116
  *UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
111
117
  *UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
112
118
  *UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
@@ -592,7 +598,11 @@ Class | Method | HTTP request | Description
592
598
  - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
593
599
  - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
594
600
  - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
601
+ - [UltracartClient::ChannelPartnerShipToPreference](docs/ChannelPartnerShipToPreference.md)
602
+ - [UltracartClient::ChannelPartnerShipToPreferenceResponse](docs/ChannelPartnerShipToPreferenceResponse.md)
603
+ - [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
595
604
  - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
605
+ - [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
596
606
  - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
597
607
  - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
598
608
  - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
@@ -1279,6 +1289,8 @@ Not every change is committed to every SDK.
1279
1289
 
1280
1290
  | Version | Date | Comments |
1281
1291
  | --: | :-: | --- |
1292
+ | 4.0.112-RC | 01/13/2023 | channel - ops to manage ship to prefs |
1293
+ | 4.0.111-RC | 01/11/2023 | conversations - adjust search results to return multiple convo summaries |
1282
1294
  | 4.0.110-RC | 01/10/2023 | add method to query integration log record by oid |
1283
1295
  | 4.0.109-RC | 01/10/2023 | bug fix for typescript enum error due to apost |
1284
1296
  | 4.0.108-RC | 01/10/2023 | integration log tracking of associated auto order oids |
@@ -6,9 +6,15 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**cancel_order_by_channel_partner_order_id**](ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id |
8
8
  | [**cancel_order_by_ultra_cart_order_id**](ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id |
9
+ | [**delete_channel_partner_ship_to_preference**](ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner. |
9
10
  | [**estimate_shipping_for_channel_partner_order**](ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order |
10
11
  | [**estimate_tax_for_channel_partner_order**](ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order |
12
+ | [**get_channel_partner_ship_to_preference**](ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id. |
13
+ | [**get_channel_partner_ship_to_preferences**](ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner. |
14
+ | [**get_channel_partners**](ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account. |
11
15
  | [**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order |
16
+ | [**insert_channel_partner_ship_to_preference**](ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner. |
17
+ | [**update_channel_partner_ship_to_preference**](ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner. |
12
18
 
13
19
 
14
20
  ## cancel_order_by_channel_partner_order_id
@@ -153,6 +159,78 @@ end
153
159
  - **Accept**: application/json
154
160
 
155
161
 
162
+ ## delete_channel_partner_ship_to_preference
163
+
164
+ > delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
165
+
166
+ Delete a ship to preference record for the channel partner.
167
+
168
+ Delete a ship to preference record for the channel partner.
169
+
170
+ ### Examples
171
+
172
+ ```ruby
173
+ require 'time'
174
+ require 'ultracart_api'
175
+ require 'json'
176
+ require 'yaml'
177
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
178
+
179
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
180
+ # As such, this might not be the best way to use this object.
181
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
182
+
183
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
184
+ channel_partner_oid = 56 # Integer |
185
+ channel_partner_ship_to_preference_oid = 56 # Integer |
186
+
187
+ begin
188
+ # Delete a ship to preference record for the channel partner.
189
+ api_instance.delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
190
+ rescue UltracartClient::ApiError => e
191
+ puts "Error when calling ChannelPartnerApi->delete_channel_partner_ship_to_preference: #{e}"
192
+ end
193
+ ```
194
+
195
+ #### Using the delete_channel_partner_ship_to_preference_with_http_info variant
196
+
197
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
198
+
199
+ > <Array(nil, Integer, Hash)> delete_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
200
+
201
+ ```ruby
202
+ begin
203
+ # Delete a ship to preference record for the channel partner.
204
+ data, status_code, headers = api_instance.delete_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => nil
208
+ rescue UltracartClient::ApiError => e
209
+ puts "Error when calling ChannelPartnerApi->delete_channel_partner_ship_to_preference_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **channel_partner_oid** | **Integer** | | |
218
+ | **channel_partner_ship_to_preference_oid** | **Integer** | | |
219
+
220
+ ### Return type
221
+
222
+ nil (empty response body)
223
+
224
+ ### Authorization
225
+
226
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
227
+
228
+ ### HTTP request headers
229
+
230
+ - **Content-Type**: Not defined
231
+ - **Accept**: application/json
232
+
233
+
156
234
  ## estimate_shipping_for_channel_partner_order
157
235
 
158
236
  > <ChannelPartnerEstimateShippingResponse> estimate_shipping_for_channel_partner_order(channel_partner_order)
@@ -295,6 +373,218 @@ end
295
373
  - **Accept**: application/json
296
374
 
297
375
 
376
+ ## get_channel_partner_ship_to_preference
377
+
378
+ > <ChannelPartnerShipToPreferenceResponse> get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
379
+
380
+ Retrieve the ship to preference associated with the channel partner and the specific id.
381
+
382
+ Retrieve the ship to preference associated with the channel partner and the specific id.
383
+
384
+ ### Examples
385
+
386
+ ```ruby
387
+ require 'time'
388
+ require 'ultracart_api'
389
+ require 'json'
390
+ require 'yaml'
391
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
392
+
393
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
394
+ # As such, this might not be the best way to use this object.
395
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
396
+
397
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
398
+ channel_partner_oid = 56 # Integer |
399
+ channel_partner_ship_to_preference_oid = 56 # Integer |
400
+
401
+ begin
402
+ # Retrieve the ship to preference associated with the channel partner and the specific id.
403
+ result = api_instance.get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
404
+ p result
405
+ rescue UltracartClient::ApiError => e
406
+ puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preference: #{e}"
407
+ end
408
+ ```
409
+
410
+ #### Using the get_channel_partner_ship_to_preference_with_http_info variant
411
+
412
+ This returns an Array which contains the response data, status code and headers.
413
+
414
+ > <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> get_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
415
+
416
+ ```ruby
417
+ begin
418
+ # Retrieve the ship to preference associated with the channel partner and the specific id.
419
+ data, status_code, headers = api_instance.get_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
420
+ p status_code # => 2xx
421
+ p headers # => { ... }
422
+ p data # => <ChannelPartnerShipToPreferenceResponse>
423
+ rescue UltracartClient::ApiError => e
424
+ puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preference_with_http_info: #{e}"
425
+ end
426
+ ```
427
+
428
+ ### Parameters
429
+
430
+ | Name | Type | Description | Notes |
431
+ | ---- | ---- | ----------- | ----- |
432
+ | **channel_partner_oid** | **Integer** | | |
433
+ | **channel_partner_ship_to_preference_oid** | **Integer** | | |
434
+
435
+ ### Return type
436
+
437
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
438
+
439
+ ### Authorization
440
+
441
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
442
+
443
+ ### HTTP request headers
444
+
445
+ - **Content-Type**: Not defined
446
+ - **Accept**: application/json
447
+
448
+
449
+ ## get_channel_partner_ship_to_preferences
450
+
451
+ > <ChannelPartnerShipToPreferencesResponse> get_channel_partner_ship_to_preferences(channel_partner_oid)
452
+
453
+ Retrieve the ship to preferences associated with the channel partner.
454
+
455
+ Retrieve the ship to preferences associated with the channel partner.
456
+
457
+ ### Examples
458
+
459
+ ```ruby
460
+ require 'time'
461
+ require 'ultracart_api'
462
+ require 'json'
463
+ require 'yaml'
464
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
465
+
466
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
467
+ # As such, this might not be the best way to use this object.
468
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
469
+
470
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
471
+ channel_partner_oid = 56 # Integer |
472
+
473
+ begin
474
+ # Retrieve the ship to preferences associated with the channel partner.
475
+ result = api_instance.get_channel_partner_ship_to_preferences(channel_partner_oid)
476
+ p result
477
+ rescue UltracartClient::ApiError => e
478
+ puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preferences: #{e}"
479
+ end
480
+ ```
481
+
482
+ #### Using the get_channel_partner_ship_to_preferences_with_http_info variant
483
+
484
+ This returns an Array which contains the response data, status code and headers.
485
+
486
+ > <Array(<ChannelPartnerShipToPreferencesResponse>, Integer, Hash)> get_channel_partner_ship_to_preferences_with_http_info(channel_partner_oid)
487
+
488
+ ```ruby
489
+ begin
490
+ # Retrieve the ship to preferences associated with the channel partner.
491
+ data, status_code, headers = api_instance.get_channel_partner_ship_to_preferences_with_http_info(channel_partner_oid)
492
+ p status_code # => 2xx
493
+ p headers # => { ... }
494
+ p data # => <ChannelPartnerShipToPreferencesResponse>
495
+ rescue UltracartClient::ApiError => e
496
+ puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preferences_with_http_info: #{e}"
497
+ end
498
+ ```
499
+
500
+ ### Parameters
501
+
502
+ | Name | Type | Description | Notes |
503
+ | ---- | ---- | ----------- | ----- |
504
+ | **channel_partner_oid** | **Integer** | | |
505
+
506
+ ### Return type
507
+
508
+ [**ChannelPartnerShipToPreferencesResponse**](ChannelPartnerShipToPreferencesResponse.md)
509
+
510
+ ### Authorization
511
+
512
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
513
+
514
+ ### HTTP request headers
515
+
516
+ - **Content-Type**: Not defined
517
+ - **Accept**: application/json
518
+
519
+
520
+ ## get_channel_partners
521
+
522
+ > <ChannelPartnersResponse> get_channel_partners
523
+
524
+ Retrieve the channel partners configured on the account.
525
+
526
+ Retrieve the channel partners configured on the account.
527
+
528
+ ### Examples
529
+
530
+ ```ruby
531
+ require 'time'
532
+ require 'ultracart_api'
533
+ require 'json'
534
+ require 'yaml'
535
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
536
+
537
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
538
+ # As such, this might not be the best way to use this object.
539
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
540
+
541
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
542
+
543
+ begin
544
+ # Retrieve the channel partners configured on the account.
545
+ result = api_instance.get_channel_partners
546
+ p result
547
+ rescue UltracartClient::ApiError => e
548
+ puts "Error when calling ChannelPartnerApi->get_channel_partners: #{e}"
549
+ end
550
+ ```
551
+
552
+ #### Using the get_channel_partners_with_http_info variant
553
+
554
+ This returns an Array which contains the response data, status code and headers.
555
+
556
+ > <Array(<ChannelPartnersResponse>, Integer, Hash)> get_channel_partners_with_http_info
557
+
558
+ ```ruby
559
+ begin
560
+ # Retrieve the channel partners configured on the account.
561
+ data, status_code, headers = api_instance.get_channel_partners_with_http_info
562
+ p status_code # => 2xx
563
+ p headers # => { ... }
564
+ p data # => <ChannelPartnersResponse>
565
+ rescue UltracartClient::ApiError => e
566
+ puts "Error when calling ChannelPartnerApi->get_channel_partners_with_http_info: #{e}"
567
+ end
568
+ ```
569
+
570
+ ### Parameters
571
+
572
+ This endpoint does not need any parameter.
573
+
574
+ ### Return type
575
+
576
+ [**ChannelPartnersResponse**](ChannelPartnersResponse.md)
577
+
578
+ ### Authorization
579
+
580
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
581
+
582
+ ### HTTP request headers
583
+
584
+ - **Content-Type**: Not defined
585
+ - **Accept**: application/json
586
+
587
+
298
588
  ## import_channel_partner_order
299
589
 
300
590
  > <ChannelPartnerImportResponse> import_channel_partner_order(channel_partner_order)
@@ -365,3 +655,151 @@ end
365
655
  - **Content-Type**: application/json; charset=UTF-8
366
656
  - **Accept**: application/json
367
657
 
658
+
659
+ ## insert_channel_partner_ship_to_preference
660
+
661
+ > <ChannelPartnerShipToPreferenceResponse> insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
662
+
663
+ Insert a ship to preference record for the channel partner.
664
+
665
+ Insert a ship to preference record for the channel partner.
666
+
667
+ ### Examples
668
+
669
+ ```ruby
670
+ require 'time'
671
+ require 'ultracart_api'
672
+ require 'json'
673
+ require 'yaml'
674
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
675
+
676
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
677
+ # As such, this might not be the best way to use this object.
678
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
679
+
680
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
681
+ channel_partner_oid = 56 # Integer |
682
+ ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
683
+
684
+ begin
685
+ # Insert a ship to preference record for the channel partner.
686
+ result = api_instance.insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
687
+ p result
688
+ rescue UltracartClient::ApiError => e
689
+ puts "Error when calling ChannelPartnerApi->insert_channel_partner_ship_to_preference: #{e}"
690
+ end
691
+ ```
692
+
693
+ #### Using the insert_channel_partner_ship_to_preference_with_http_info variant
694
+
695
+ This returns an Array which contains the response data, status code and headers.
696
+
697
+ > <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> insert_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, ship_to_preference)
698
+
699
+ ```ruby
700
+ begin
701
+ # Insert a ship to preference record for the channel partner.
702
+ data, status_code, headers = api_instance.insert_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, ship_to_preference)
703
+ p status_code # => 2xx
704
+ p headers # => { ... }
705
+ p data # => <ChannelPartnerShipToPreferenceResponse>
706
+ rescue UltracartClient::ApiError => e
707
+ puts "Error when calling ChannelPartnerApi->insert_channel_partner_ship_to_preference_with_http_info: #{e}"
708
+ end
709
+ ```
710
+
711
+ ### Parameters
712
+
713
+ | Name | Type | Description | Notes |
714
+ | ---- | ---- | ----------- | ----- |
715
+ | **channel_partner_oid** | **Integer** | | |
716
+ | **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | Ship to preference to create | |
717
+
718
+ ### Return type
719
+
720
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
721
+
722
+ ### Authorization
723
+
724
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: application/json
729
+ - **Accept**: application/json
730
+
731
+
732
+ ## update_channel_partner_ship_to_preference
733
+
734
+ > <ChannelPartnerShipToPreferenceResponse> update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
735
+
736
+ Update a ship to preference record for the channel partner.
737
+
738
+ Update a ship to preference record for the channel partner.
739
+
740
+ ### Examples
741
+
742
+ ```ruby
743
+ require 'time'
744
+ require 'ultracart_api'
745
+ require 'json'
746
+ require 'yaml'
747
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
748
+
749
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
750
+ # As such, this might not be the best way to use this object.
751
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
752
+
753
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
754
+ channel_partner_oid = 56 # Integer |
755
+ channel_partner_ship_to_preference_oid = 56 # Integer |
756
+ ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
757
+
758
+ begin
759
+ # Update a ship to preference record for the channel partner.
760
+ result = api_instance.update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
761
+ p result
762
+ rescue UltracartClient::ApiError => e
763
+ puts "Error when calling ChannelPartnerApi->update_channel_partner_ship_to_preference: #{e}"
764
+ end
765
+ ```
766
+
767
+ #### Using the update_channel_partner_ship_to_preference_with_http_info variant
768
+
769
+ This returns an Array which contains the response data, status code and headers.
770
+
771
+ > <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> update_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
772
+
773
+ ```ruby
774
+ begin
775
+ # Update a ship to preference record for the channel partner.
776
+ data, status_code, headers = api_instance.update_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
777
+ p status_code # => 2xx
778
+ p headers # => { ... }
779
+ p data # => <ChannelPartnerShipToPreferenceResponse>
780
+ rescue UltracartClient::ApiError => e
781
+ puts "Error when calling ChannelPartnerApi->update_channel_partner_ship_to_preference_with_http_info: #{e}"
782
+ end
783
+ ```
784
+
785
+ ### Parameters
786
+
787
+ | Name | Type | Description | Notes |
788
+ | ---- | ---- | ----------- | ----- |
789
+ | **channel_partner_oid** | **Integer** | | |
790
+ | **channel_partner_ship_to_preference_oid** | **Integer** | | |
791
+ | **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | Ship to preference to create | |
792
+
793
+ ### Return type
794
+
795
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
796
+
797
+ ### Authorization
798
+
799
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
800
+
801
+ ### HTTP request headers
802
+
803
+ - **Content-Type**: application/json
804
+ - **Accept**: application/json
805
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::ChannelPartnerShipToPreference
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **additional_kit_component_item_ids** | **Array&lt;String&gt;** | Additional item ids to add as kit components to the order with a zero price. | [optional] |
8
+ | **channel_partner_oid** | **Integer** | The channel partner object identifier this preference is associated with | [optional] |
9
+ | **channel_partner_ship_to_preference_oid** | **Integer** | Object identifier for the ship to preference | [optional] |
10
+ | **merchant_id** | **String** | The merchant id that owns the channel partner | [optional] |
11
+ | **return_policy** | **String** | Alternate return policy to print on the packing slip. | [optional] |
12
+ | **ship_to_edi_code** | **String** | The ship to EDI code that the preferences are for | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::ChannelPartnerShipToPreference.new(
20
+ additional_kit_component_item_ids: null,
21
+ channel_partner_oid: null,
22
+ channel_partner_ship_to_preference_oid: null,
23
+ merchant_id: null,
24
+ return_policy: null,
25
+ ship_to_edi_code: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ChannelPartnerShipToPreferenceResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ChannelPartnerShipToPreferenceResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ ship_to_preference: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ChannelPartnerShipToPreferencesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **ship_to_preferences** | [**Array&lt;ChannelPartnerShipToPreference&gt;**](ChannelPartnerShipToPreference.md) | ship_to_preferences | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ChannelPartnerShipToPreferencesResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ ship_to_preferences: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ChannelPartnersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **channel_partners** | [**Array&lt;ChannelPartner&gt;**](ChannelPartner.md) | channel_partners | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ChannelPartnersResponse.new(
19
+ channel_partners: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **range_begin** | **Integer** | | [optional] |
8
8
  | **range_end** | **Integer** | | [optional] |
9
- | **records** | [**Array&lt;Conversation&gt;**](Conversation.md) | | [optional] |
9
+ | **records** | [**Array&lt;ConversationSummary&gt;**](ConversationSummary.md) | | [optional] |
10
10
  | **total** | **Integer** | | [optional] |
11
11
 
12
12
  ## Example