ultracart_api 4.0.245 → 4.1.1

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: 5fc458d910bbb9eac7c8b2988187aca4dfe9ba66d1c69bf329a25d807779549e
4
- data.tar.gz: 2d7fcbc7acf33aa496232219183033be746e0f59a958e443062cdefc752d9c87
3
+ metadata.gz: 2702bba78ca5ee501e75efd5da0b7623b0f1f88f3c156990fa5a581331b4bc60
4
+ data.tar.gz: e99581479a78d6dd159d0e42346b6d1c661cb052ac6ae5379af079d8f5309f06
5
5
  SHA512:
6
- metadata.gz: 306cbaf33017585854f3a1808c10cb0512f818a00a24c46514c1d9003b18638247b36f5dcdf201632ce377fcce9d2f712be60bca43a83ce658d2e29e32fc8b0e
7
- data.tar.gz: 07d2a4ec531d4527985f1126f63891a3d3fdb9f854cccde44570c5265b6844f335dd8bc5f1f7d95a9f6c3f65c365df1c3829b4b5dc81ca3bc540ea81e657ea43
6
+ metadata.gz: afe1106c6b971c1c8d88529402faa865c1d0adc24f4ddab1f8710bb1c614b91082ed699f7eac1a15a474e49cc6745950a88b0a05302977270ba127c14e76cc48
7
+ data.tar.gz: 5ffef7b103437483dbfa3358dc57aa4a24f9575a05cf85a1de04ac996f1a0b1cf06e2fbb641f4edcce9b4fd0a7e6d567d3e027557ea34079347a740affcda072
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.245
10
+ - Package version: 4.1.1
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.245.gem
27
+ gem install ./ultracart_api-4.1.1.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.245.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.1.1.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.245'
36
+ gem 'ultracart_api', '~> 4.1.1'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
102
102
  *UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
103
103
  *UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
104
104
  *UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
105
+ *UltracartClient::AutoOrderApi* | [**pause_auto_order**](docs/AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order
105
106
  *UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
106
107
  *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
107
108
  *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
@@ -303,6 +304,7 @@ Class | Method | HTTP request | Description
303
304
  *UltracartClient::ItemApi* | [**get_digital_item**](docs/ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
304
305
  *UltracartClient::ItemApi* | [**get_digital_items**](docs/ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
305
306
  *UltracartClient::ItemApi* | [**get_digital_items_by_external_id**](docs/ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
307
+ *UltracartClient::ItemApi* | [**get_inventory_snapshot**](docs/ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
306
308
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
307
309
  *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
308
310
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
@@ -314,7 +316,6 @@ Class | Method | HTTP request | Description
314
316
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
315
317
  *UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
316
318
  *UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
317
- *UltracartClient::ItemApi* | [**rest_item_inventory_snapshot_response**](docs/ItemApi.md#rest_item_inventory_snapshot_response) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
318
319
  *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
319
320
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
320
321
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
@@ -1525,6 +1526,8 @@ Not every change is committed to every SDK.
1525
1526
 
1526
1527
  | Version | Date | Comments |
1527
1528
  | --: | :-: | --- |
1529
+ | 4.1.1 | 02/28/2025 | auto order pause method |
1530
+ | 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
1528
1531
  | 4.0.245 | 02/20/2025 | automation fix |
1529
1532
  | 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
1530
1533
  | 4.0.243 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
data/docs/AutoOrderApi.md CHANGED
@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
12
12
  | [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders |
13
13
  | [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch |
14
14
  | [**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query |
15
+ | [**pause_auto_order**](AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order |
15
16
  | [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order |
16
17
  | [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
17
18
 
@@ -666,6 +667,83 @@ end
666
667
  - **Accept**: application/json
667
668
 
668
669
 
670
+ ## pause_auto_order
671
+
672
+ > <AutoOrderResponse> pause_auto_order(auto_order_oid, auto_order, opts)
673
+
674
+ Pause auto order
675
+
676
+ Completely pause an auto order
677
+
678
+ ### Examples
679
+
680
+ ```ruby
681
+ require 'time'
682
+ require 'ultracart_api'
683
+ require 'json'
684
+ require 'yaml'
685
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
686
+
687
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
688
+ # As such, this might not be the best way to use this object.
689
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
690
+
691
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
692
+ auto_order_oid = 56 # Integer | The auto order oid to pause.
693
+ auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto orders to pause
694
+ opts = {
695
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
696
+ }
697
+
698
+ begin
699
+ # Pause auto order
700
+ result = api_instance.pause_auto_order(auto_order_oid, auto_order, opts)
701
+ p result
702
+ rescue UltracartClient::ApiError => e
703
+ puts "Error when calling AutoOrderApi->pause_auto_order: #{e}"
704
+ end
705
+ ```
706
+
707
+ #### Using the pause_auto_order_with_http_info variant
708
+
709
+ This returns an Array which contains the response data, status code and headers.
710
+
711
+ > <Array(<AutoOrderResponse>, Integer, Hash)> pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
712
+
713
+ ```ruby
714
+ begin
715
+ # Pause auto order
716
+ data, status_code, headers = api_instance.pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
717
+ p status_code # => 2xx
718
+ p headers # => { ... }
719
+ p data # => <AutoOrderResponse>
720
+ rescue UltracartClient::ApiError => e
721
+ puts "Error when calling AutoOrderApi->pause_auto_order_with_http_info: #{e}"
722
+ end
723
+ ```
724
+
725
+ ### Parameters
726
+
727
+ | Name | Type | Description | Notes |
728
+ | ---- | ---- | ----------- | ----- |
729
+ | **auto_order_oid** | **Integer** | The auto order oid to pause. | |
730
+ | **auto_order** | [**AutoOrder**](AutoOrder.md) | Auto orders to pause | |
731
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
732
+
733
+ ### Return type
734
+
735
+ [**AutoOrderResponse**](AutoOrderResponse.md)
736
+
737
+ ### Authorization
738
+
739
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
740
+
741
+ ### HTTP request headers
742
+
743
+ - **Content-Type**: application/json; charset=UTF-8
744
+ - **Accept**: application/json
745
+
746
+
669
747
  ## update_auto_order
670
748
 
671
749
  > <AutoOrderResponse> update_auto_order(auto_order_oid, auto_order, opts)
data/docs/ItemApi.md CHANGED
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
10
10
  | [**get_digital_item**](ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items |
11
11
  | [**get_digital_items**](ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items |
12
12
  | [**get_digital_items_by_external_id**](ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id |
13
+ | [**get_inventory_snapshot**](ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response. |
13
14
  | [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item |
14
15
  | [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id |
15
16
  | [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
@@ -21,7 +22,6 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
21
22
  | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
22
23
  | [**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review |
23
24
  | [**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute |
24
- | [**rest_item_inventory_snapshot_response**](ItemApi.md#rest_item_inventory_snapshot_response) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response. |
25
25
  | [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
26
26
  | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
27
27
  | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
@@ -466,6 +466,74 @@ end
466
466
  - **Accept**: application/json
467
467
 
468
468
 
469
+ ## get_inventory_snapshot
470
+
471
+ > <ItemInventorySnapshotResponse> get_inventory_snapshot
472
+
473
+ Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
474
+
475
+ Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
476
+
477
+ ### Examples
478
+
479
+ ```ruby
480
+ require 'time'
481
+ require 'ultracart_api'
482
+ require 'json'
483
+ require 'yaml'
484
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
485
+
486
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
487
+ # As such, this might not be the best way to use this object.
488
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
489
+
490
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
491
+
492
+ begin
493
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
494
+ result = api_instance.get_inventory_snapshot
495
+ p result
496
+ rescue UltracartClient::ApiError => e
497
+ puts "Error when calling ItemApi->get_inventory_snapshot: #{e}"
498
+ end
499
+ ```
500
+
501
+ #### Using the get_inventory_snapshot_with_http_info variant
502
+
503
+ This returns an Array which contains the response data, status code and headers.
504
+
505
+ > <Array(<ItemInventorySnapshotResponse>, Integer, Hash)> get_inventory_snapshot_with_http_info
506
+
507
+ ```ruby
508
+ begin
509
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
510
+ data, status_code, headers = api_instance.get_inventory_snapshot_with_http_info
511
+ p status_code # => 2xx
512
+ p headers # => { ... }
513
+ p data # => <ItemInventorySnapshotResponse>
514
+ rescue UltracartClient::ApiError => e
515
+ puts "Error when calling ItemApi->get_inventory_snapshot_with_http_info: #{e}"
516
+ end
517
+ ```
518
+
519
+ ### Parameters
520
+
521
+ This endpoint does not need any parameter.
522
+
523
+ ### Return type
524
+
525
+ [**ItemInventorySnapshotResponse**](ItemInventorySnapshotResponse.md)
526
+
527
+ ### Authorization
528
+
529
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: Not defined
534
+ - **Accept**: application/json
535
+
536
+
469
537
  ## get_item
470
538
 
471
539
  > <ItemResponse> get_item(merchant_item_oid, opts)
@@ -1300,74 +1368,6 @@ nil (empty response body)
1300
1368
  - **Accept**: application/json
1301
1369
 
1302
1370
 
1303
- ## rest_item_inventory_snapshot_response
1304
-
1305
- > <ItemInventorySnapshotResponse> rest_item_inventory_snapshot_response
1306
-
1307
- Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1308
-
1309
- Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1310
-
1311
- ### Examples
1312
-
1313
- ```ruby
1314
- require 'time'
1315
- require 'ultracart_api'
1316
- require 'json'
1317
- require 'yaml'
1318
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1319
-
1320
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1321
- # As such, this might not be the best way to use this object.
1322
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1323
-
1324
- api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1325
-
1326
- begin
1327
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1328
- result = api_instance.rest_item_inventory_snapshot_response
1329
- p result
1330
- rescue UltracartClient::ApiError => e
1331
- puts "Error when calling ItemApi->rest_item_inventory_snapshot_response: #{e}"
1332
- end
1333
- ```
1334
-
1335
- #### Using the rest_item_inventory_snapshot_response_with_http_info variant
1336
-
1337
- This returns an Array which contains the response data, status code and headers.
1338
-
1339
- > <Array(<ItemInventorySnapshotResponse>, Integer, Hash)> rest_item_inventory_snapshot_response_with_http_info
1340
-
1341
- ```ruby
1342
- begin
1343
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1344
- data, status_code, headers = api_instance.rest_item_inventory_snapshot_response_with_http_info
1345
- p status_code # => 2xx
1346
- p headers # => { ... }
1347
- p data # => <ItemInventorySnapshotResponse>
1348
- rescue UltracartClient::ApiError => e
1349
- puts "Error when calling ItemApi->rest_item_inventory_snapshot_response_with_http_info: #{e}"
1350
- end
1351
- ```
1352
-
1353
- ### Parameters
1354
-
1355
- This endpoint does not need any parameter.
1356
-
1357
- ### Return type
1358
-
1359
- [**ItemInventorySnapshotResponse**](ItemInventorySnapshotResponse.md)
1360
-
1361
- ### Authorization
1362
-
1363
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1364
-
1365
- ### HTTP request headers
1366
-
1367
- - **Content-Type**: Not defined
1368
- - **Accept**: application/json
1369
-
1370
-
1371
1371
  ## update_digital_item
1372
1372
 
1373
1373
  > <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **block_prepaid** | **Boolean** | True if prepaid cards should be blocked from buying this item | [optional] |
8
- | **block_refunds** | **Boolean** | True if this item should block any refund attempts | [optional] |
8
+ | **block_refunds** | **Boolean** | True if this item should block any refund attempts, set to false otherwise, null value will not update the field | [optional] |
9
9
  | **credit_card_transaction_type** | **String** | Credit card transaction type | [optional] |
10
10
  | **no_realtime_charge** | **Boolean** | True if no real-time charge should be performed on this item. | [optional] |
11
11
  | **payment_method_validity** | **Array&lt;String&gt;** | Payment method validity | [optional] |
data/docs/OrderCoupon.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **automatically_applied** | **Boolean** | Whether or not the coupon was automatically applied to the order | [optional] |
9
9
  | **base_coupon_code** | **String** | Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon | [optional] |
10
10
  | **coupon_code** | **String** | Coupon code entered by the customer | [optional] |
11
- | **hdie_from_customer** | **Boolean** | True if this coupon is hidde from the customer | [optional] |
11
+ | **hdie_from_customer** | **Boolean** | True if this coupon is hide from the customer | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -658,6 +658,84 @@ module UltracartClient
658
658
  return data, status_code, headers
659
659
  end
660
660
 
661
+ # Pause auto order
662
+ # Completely pause an auto order
663
+ # @param auto_order_oid [Integer] The auto order oid to pause.
664
+ # @param auto_order [AutoOrder] Auto orders to pause
665
+ # @param [Hash] opts the optional parameters
666
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
667
+ # @return [AutoOrderResponse]
668
+ def pause_auto_order(auto_order_oid, auto_order, opts = {})
669
+ data, _status_code, _headers = pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
670
+ data
671
+ end
672
+
673
+ # Pause auto order
674
+ # Completely pause an auto order
675
+ # @param auto_order_oid [Integer] The auto order oid to pause.
676
+ # @param auto_order [AutoOrder] Auto orders to pause
677
+ # @param [Hash] opts the optional parameters
678
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
679
+ # @return [Array<(AutoOrderResponse, Integer, Hash)>] AutoOrderResponse data, response status code and response headers
680
+ def pause_auto_order_with_http_info(auto_order_oid, auto_order, opts = {})
681
+ if @api_client.config.debugging
682
+ @api_client.config.logger.debug 'Calling API: AutoOrderApi.pause_auto_order ...'
683
+ end
684
+ # verify the required parameter 'auto_order_oid' is set
685
+ if @api_client.config.client_side_validation && auto_order_oid.nil?
686
+ fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.pause_auto_order"
687
+ end
688
+ # verify the required parameter 'auto_order' is set
689
+ if @api_client.config.client_side_validation && auto_order.nil?
690
+ fail ArgumentError, "Missing the required parameter 'auto_order' when calling AutoOrderApi.pause_auto_order"
691
+ end
692
+ # resource path
693
+ local_var_path = '/auto_order/auto_orders/{auto_order_oid}/pause'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
694
+
695
+ # query parameters
696
+ query_params = opts[:query_params] || {}
697
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
698
+
699
+ # header parameters
700
+ header_params = opts[:header_params] || {}
701
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
702
+ # HTTP header 'Accept' (if needed)
703
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
704
+ # HTTP header 'Content-Type'
705
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
706
+ if !content_type.nil?
707
+ header_params['Content-Type'] = content_type
708
+ end
709
+
710
+ # form parameters
711
+ form_params = opts[:form_params] || {}
712
+
713
+ # http body (model)
714
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(auto_order)
715
+
716
+ # return_type
717
+ return_type = opts[:debug_return_type] || 'AutoOrderResponse'
718
+
719
+ # auth_names
720
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
721
+
722
+ new_options = opts.merge(
723
+ :operation => :"AutoOrderApi.pause_auto_order",
724
+ :header_params => header_params,
725
+ :query_params => query_params,
726
+ :form_params => form_params,
727
+ :body => post_body,
728
+ :auth_names => auth_names,
729
+ :return_type => return_type
730
+ )
731
+
732
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
733
+ if @api_client.config.debugging
734
+ @api_client.config.logger.debug "API called: AutoOrderApi#pause_auto_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
735
+ end
736
+ return data, status_code, headers
737
+ end
738
+
661
739
  # Update an auto order
662
740
  # Update an auto order on the UltraCart account.
663
741
  # @param auto_order_oid [Integer] The auto order oid to update.
@@ -434,6 +434,64 @@ module UltracartClient
434
434
  return data, status_code, headers
435
435
  end
436
436
 
437
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
438
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
439
+ # @param [Hash] opts the optional parameters
440
+ # @return [ItemInventorySnapshotResponse]
441
+ def get_inventory_snapshot(opts = {})
442
+ data, _status_code, _headers = get_inventory_snapshot_with_http_info(opts)
443
+ data
444
+ end
445
+
446
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
447
+ # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
448
+ # @param [Hash] opts the optional parameters
449
+ # @return [Array<(ItemInventorySnapshotResponse, Integer, Hash)>] ItemInventorySnapshotResponse data, response status code and response headers
450
+ def get_inventory_snapshot_with_http_info(opts = {})
451
+ if @api_client.config.debugging
452
+ @api_client.config.logger.debug 'Calling API: ItemApi.get_inventory_snapshot ...'
453
+ end
454
+ # resource path
455
+ local_var_path = '/item/items/inventory_snapshot'
456
+
457
+ # query parameters
458
+ query_params = opts[:query_params] || {}
459
+
460
+ # header parameters
461
+ header_params = opts[:header_params] || {}
462
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
463
+ # HTTP header 'Accept' (if needed)
464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
465
+
466
+ # form parameters
467
+ form_params = opts[:form_params] || {}
468
+
469
+ # http body (model)
470
+ post_body = opts[:debug_body]
471
+
472
+ # return_type
473
+ return_type = opts[:debug_return_type] || 'ItemInventorySnapshotResponse'
474
+
475
+ # auth_names
476
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
477
+
478
+ new_options = opts.merge(
479
+ :operation => :"ItemApi.get_inventory_snapshot",
480
+ :header_params => header_params,
481
+ :query_params => query_params,
482
+ :form_params => form_params,
483
+ :body => post_body,
484
+ :auth_names => auth_names,
485
+ :return_type => return_type
486
+ )
487
+
488
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug "API called: ItemApi#get_inventory_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
491
+ end
492
+ return data, status_code, headers
493
+ end
494
+
437
495
  # Retrieve an item
438
496
  # Retrieves a single item using the specified item oid.
439
497
  # @param merchant_item_oid [Integer] The item oid to retrieve.
@@ -1221,64 +1279,6 @@ module UltracartClient
1221
1279
  return data, status_code, headers
1222
1280
  end
1223
1281
 
1224
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1225
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1226
- # @param [Hash] opts the optional parameters
1227
- # @return [ItemInventorySnapshotResponse]
1228
- def rest_item_inventory_snapshot_response(opts = {})
1229
- data, _status_code, _headers = rest_item_inventory_snapshot_response_with_http_info(opts)
1230
- data
1231
- end
1232
-
1233
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1234
- # Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
1235
- # @param [Hash] opts the optional parameters
1236
- # @return [Array<(ItemInventorySnapshotResponse, Integer, Hash)>] ItemInventorySnapshotResponse data, response status code and response headers
1237
- def rest_item_inventory_snapshot_response_with_http_info(opts = {})
1238
- if @api_client.config.debugging
1239
- @api_client.config.logger.debug 'Calling API: ItemApi.rest_item_inventory_snapshot_response ...'
1240
- end
1241
- # resource path
1242
- local_var_path = '/item/items/inventory_snapshot'
1243
-
1244
- # query parameters
1245
- query_params = opts[:query_params] || {}
1246
-
1247
- # header parameters
1248
- header_params = opts[:header_params] || {}
1249
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1250
- # HTTP header 'Accept' (if needed)
1251
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1252
-
1253
- # form parameters
1254
- form_params = opts[:form_params] || {}
1255
-
1256
- # http body (model)
1257
- post_body = opts[:debug_body]
1258
-
1259
- # return_type
1260
- return_type = opts[:debug_return_type] || 'ItemInventorySnapshotResponse'
1261
-
1262
- # auth_names
1263
- auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1264
-
1265
- new_options = opts.merge(
1266
- :operation => :"ItemApi.rest_item_inventory_snapshot_response",
1267
- :header_params => header_params,
1268
- :query_params => query_params,
1269
- :form_params => form_params,
1270
- :body => post_body,
1271
- :auth_names => auth_names,
1272
- :return_type => return_type
1273
- )
1274
-
1275
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1276
- if @api_client.config.debugging
1277
- @api_client.config.logger.debug "API called: ItemApi#rest_item_inventory_snapshot_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1278
- end
1279
- return data, status_code, headers
1280
- end
1281
-
1282
1282
  # Updates a file within the digital library
1283
1283
  # Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
1284
1284
  # @param digital_item_oid [Integer] The digital item oid to update.
@@ -18,7 +18,7 @@ module UltracartClient
18
18
  # True if prepaid cards should be blocked from buying this item
19
19
  attr_accessor :block_prepaid
20
20
 
21
- # True if this item should block any refund attempts
21
+ # True if this item should block any refund attempts, set to false otherwise, null value will not update the field
22
22
  attr_accessor :block_refunds
23
23
 
24
24
  # Credit card transaction type
@@ -27,7 +27,7 @@ module UltracartClient
27
27
  # Coupon code entered by the customer
28
28
  attr_accessor :coupon_code
29
29
 
30
- # True if this coupon is hidde from the customer
30
+ # True if this coupon is hide from the customer
31
31
  attr_accessor :hdie_from_customer
32
32
 
33
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.0.245'
14
+ VERSION = '4.1.1'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.245
4
+ version: 4.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-02-20 00:00:00.000000000 Z
11
+ date: 2025-02-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus