ultracart_api 4.0.242 → 4.1.0
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 +4 -4
- data/README.md +10 -5
- data/docs/ItemApi.md +69 -69
- data/docs/OrderPayment.md +2 -0
- data/docs/OrderPaymentPayPal.md +20 -0
- data/lib/ultracart_api/api/item_api.rb +58 -58
- data/lib/ultracart_api/models/order_payment.rb +10 -1
- data/lib/ultracart_api/models/order_payment_pay_pal.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9d46dfb7ff0455ff0df2aa20ff1e7ff78864bc77f1c62ec6c0fb16aa81bdd86b
|
4
|
+
data.tar.gz: fa003a82c58cf2c1019b358d865389a743044a72ef7073d8f6c8dbcb4a6f4ce9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 839904a8688f6a5507831a95a25a16aa83d0b179013a5978e8c85fe5b6cce49f2f20e1e3d451b3afe7808a97f537876c8532d47b14f1246c9100961241b66110
|
7
|
+
data.tar.gz: f5b917a3b63c48d6f42751da7ca55790282c7fc43cdf743e125dfc54511e2328ede5f4d44dd731a343a4ae064cf940015960d609d25f210515e724542cf7881e
|
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
|
10
|
+
- Package version: 4.1.0
|
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.
|
27
|
+
gem install ./ultracart_api-4.1.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.1.0.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
|
36
|
+
gem 'ultracart_api', '~> 4.1.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -303,6 +303,7 @@ Class | Method | HTTP request | Description
|
|
303
303
|
*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
304
|
*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
305
|
*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
|
306
|
+
*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
307
|
*UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
307
308
|
*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
309
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
@@ -314,7 +315,6 @@ Class | Method | HTTP request | Description
|
|
314
315
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
315
316
|
*UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
316
317
|
*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
318
|
*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
319
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
320
320
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
@@ -1243,6 +1243,7 @@ Class | Method | HTTP request | Description
|
|
1243
1243
|
- [UltracartClient::OrderPaymentECheck](docs/OrderPaymentECheck.md)
|
1244
1244
|
- [UltracartClient::OrderPaymentHealthBenefitCard](docs/OrderPaymentHealthBenefitCard.md)
|
1245
1245
|
- [UltracartClient::OrderPaymentInsurance](docs/OrderPaymentInsurance.md)
|
1246
|
+
- [UltracartClient::OrderPaymentPayPal](docs/OrderPaymentPayPal.md)
|
1246
1247
|
- [UltracartClient::OrderPaymentPurchaseOrder](docs/OrderPaymentPurchaseOrder.md)
|
1247
1248
|
- [UltracartClient::OrderPaymentTransaction](docs/OrderPaymentTransaction.md)
|
1248
1249
|
- [UltracartClient::OrderPaymentTransactionDetail](docs/OrderPaymentTransactionDetail.md)
|
@@ -1524,6 +1525,10 @@ Not every change is committed to every SDK.
|
|
1524
1525
|
|
1525
1526
|
| Version | Date | Comments |
|
1526
1527
|
| --: | :-: | --- |
|
1528
|
+
| 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
|
1529
|
+
| 4.0.245 | 02/20/2025 | automation fix |
|
1530
|
+
| 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
1531
|
+
| 4.0.243 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
1527
1532
|
| 4.0.242 | 02/18/2025 | small bug fixes for incorrect return types on several methods |
|
1528
1533
|
| 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
|
1529
1534
|
| 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
|
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)
|
data/docs/OrderPayment.md
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
| **payment_method_accounting_code** | **String** | Payment method QuickBooks code | [optional] |
|
16
16
|
| **payment_method_deposit_to_account** | **String** | Payment method QuickBooks deposit account | [optional] |
|
17
17
|
| **payment_status** | **String** | Payment status | [optional] |
|
18
|
+
| **paypal** | [**OrderPaymentPayPal**](OrderPaymentPayPal.md) | | [optional] |
|
18
19
|
| **purchase_order** | [**OrderPaymentPurchaseOrder**](OrderPaymentPurchaseOrder.md) | | [optional] |
|
19
20
|
| **rotating_transaction_gateway_code** | **String** | Rotating transaction gateway code used to process this order | [optional] |
|
20
21
|
| **surcharge** | [**Currency**](Currency.md) | | [optional] |
|
@@ -41,6 +42,7 @@ instance = UltracartClient::OrderPayment.new(
|
|
41
42
|
payment_method_accounting_code: null,
|
42
43
|
payment_method_deposit_to_account: null,
|
43
44
|
payment_status: null,
|
45
|
+
paypal: null,
|
44
46
|
purchase_order: null,
|
45
47
|
rotating_transaction_gateway_code: null,
|
46
48
|
surcharge: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::OrderPaymentPayPal
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_id** | **String** | PayPal Customer ID | [optional] |
|
8
|
+
| **vault_id** | **String** | PayPal Vault ID | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::OrderPaymentPayPal.new(
|
16
|
+
customer_id: null,
|
17
|
+
vault_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -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.
|
@@ -43,6 +43,8 @@ module UltracartClient
|
|
43
43
|
# Payment status
|
44
44
|
attr_accessor :payment_status
|
45
45
|
|
46
|
+
attr_accessor :paypal
|
47
|
+
|
46
48
|
attr_accessor :purchase_order
|
47
49
|
|
48
50
|
# Rotating transaction gateway code used to process this order
|
@@ -101,6 +103,7 @@ module UltracartClient
|
|
101
103
|
:'payment_method_accounting_code' => :'payment_method_accounting_code',
|
102
104
|
:'payment_method_deposit_to_account' => :'payment_method_deposit_to_account',
|
103
105
|
:'payment_status' => :'payment_status',
|
106
|
+
:'paypal' => :'paypal',
|
104
107
|
:'purchase_order' => :'purchase_order',
|
105
108
|
:'rotating_transaction_gateway_code' => :'rotating_transaction_gateway_code',
|
106
109
|
:'surcharge' => :'surcharge',
|
@@ -131,6 +134,7 @@ module UltracartClient
|
|
131
134
|
:'payment_method_accounting_code' => :'String',
|
132
135
|
:'payment_method_deposit_to_account' => :'String',
|
133
136
|
:'payment_status' => :'String',
|
137
|
+
:'paypal' => :'OrderPaymentPayPal',
|
134
138
|
:'purchase_order' => :'OrderPaymentPurchaseOrder',
|
135
139
|
:'rotating_transaction_gateway_code' => :'String',
|
136
140
|
:'surcharge' => :'Currency',
|
@@ -207,6 +211,10 @@ module UltracartClient
|
|
207
211
|
self.payment_status = attributes[:'payment_status']
|
208
212
|
end
|
209
213
|
|
214
|
+
if attributes.key?(:'paypal')
|
215
|
+
self.paypal = attributes[:'paypal']
|
216
|
+
end
|
217
|
+
|
210
218
|
if attributes.key?(:'purchase_order')
|
211
219
|
self.purchase_order = attributes[:'purchase_order']
|
212
220
|
end
|
@@ -295,6 +303,7 @@ module UltracartClient
|
|
295
303
|
payment_method_accounting_code == o.payment_method_accounting_code &&
|
296
304
|
payment_method_deposit_to_account == o.payment_method_deposit_to_account &&
|
297
305
|
payment_status == o.payment_status &&
|
306
|
+
paypal == o.paypal &&
|
298
307
|
purchase_order == o.purchase_order &&
|
299
308
|
rotating_transaction_gateway_code == o.rotating_transaction_gateway_code &&
|
300
309
|
surcharge == o.surcharge &&
|
@@ -314,7 +323,7 @@ module UltracartClient
|
|
314
323
|
# Calculates hash code according to all attributes.
|
315
324
|
# @return [Integer] Hash code
|
316
325
|
def hash
|
317
|
-
[check, credit_card, echeck, health_benefit_card, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, payment_method_deposit_to_account, payment_status, purchase_order, rotating_transaction_gateway_code, surcharge, surcharge_accounting_code, surcharge_transaction_fee, surcharge_transaction_percentage, test_order, transactions].hash
|
326
|
+
[check, credit_card, echeck, health_benefit_card, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, payment_method_deposit_to_account, payment_status, paypal, purchase_order, rotating_transaction_gateway_code, surcharge, surcharge_accounting_code, surcharge_transaction_fee, surcharge_transaction_percentage, test_order, transactions].hash
|
318
327
|
end
|
319
328
|
|
320
329
|
# Builds the object from hash
|
@@ -0,0 +1,230 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module UltracartClient
|
17
|
+
class OrderPaymentPayPal
|
18
|
+
# PayPal Customer ID
|
19
|
+
attr_accessor :customer_id
|
20
|
+
|
21
|
+
# PayPal Vault ID
|
22
|
+
attr_accessor :vault_id
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'customer_id' => :'customer_id',
|
28
|
+
:'vault_id' => :'vault_id'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Returns all the JSON keys this model knows about
|
33
|
+
def self.acceptable_attributes
|
34
|
+
attribute_map.values
|
35
|
+
end
|
36
|
+
|
37
|
+
# Attribute type mapping.
|
38
|
+
def self.openapi_types
|
39
|
+
{
|
40
|
+
:'customer_id' => :'String',
|
41
|
+
:'vault_id' => :'String'
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# List of attributes with nullable: true
|
46
|
+
def self.openapi_nullable
|
47
|
+
Set.new([
|
48
|
+
])
|
49
|
+
end
|
50
|
+
|
51
|
+
# Initializes the object
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
53
|
+
def initialize(attributes = {})
|
54
|
+
if (!attributes.is_a?(Hash))
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderPaymentPayPal` initialize method"
|
56
|
+
end
|
57
|
+
|
58
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
60
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
61
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderPaymentPayPal`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
62
|
+
end
|
63
|
+
h[k.to_sym] = v
|
64
|
+
}
|
65
|
+
|
66
|
+
if attributes.key?(:'customer_id')
|
67
|
+
self.customer_id = attributes[:'customer_id']
|
68
|
+
end
|
69
|
+
|
70
|
+
if attributes.key?(:'vault_id')
|
71
|
+
self.vault_id = attributes[:'vault_id']
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
76
|
+
# @return Array for valid properties with the reasons
|
77
|
+
def list_invalid_properties
|
78
|
+
invalid_properties = Array.new
|
79
|
+
invalid_properties
|
80
|
+
end
|
81
|
+
|
82
|
+
# Check to see if the all the properties in the model are valid
|
83
|
+
# @return true if the model is valid
|
84
|
+
def valid?
|
85
|
+
true
|
86
|
+
end
|
87
|
+
|
88
|
+
# Checks equality by comparing each attribute.
|
89
|
+
# @param [Object] Object to be compared
|
90
|
+
def ==(o)
|
91
|
+
return true if self.equal?(o)
|
92
|
+
self.class == o.class &&
|
93
|
+
customer_id == o.customer_id &&
|
94
|
+
vault_id == o.vault_id
|
95
|
+
end
|
96
|
+
|
97
|
+
# @see the `==` method
|
98
|
+
# @param [Object] Object to be compared
|
99
|
+
def eql?(o)
|
100
|
+
self == o
|
101
|
+
end
|
102
|
+
|
103
|
+
# Calculates hash code according to all attributes.
|
104
|
+
# @return [Integer] Hash code
|
105
|
+
def hash
|
106
|
+
[customer_id, vault_id].hash
|
107
|
+
end
|
108
|
+
|
109
|
+
# Builds the object from hash
|
110
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
111
|
+
# @return [Object] Returns the model itself
|
112
|
+
def self.build_from_hash(attributes)
|
113
|
+
new.build_from_hash(attributes)
|
114
|
+
end
|
115
|
+
|
116
|
+
# Builds the object from hash
|
117
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
118
|
+
# @return [Object] Returns the model itself
|
119
|
+
def build_from_hash(attributes)
|
120
|
+
return nil unless attributes.is_a?(Hash)
|
121
|
+
attributes = attributes.transform_keys(&:to_sym)
|
122
|
+
self.class.openapi_types.each_pair do |key, type|
|
123
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
124
|
+
self.send("#{key}=", nil)
|
125
|
+
elsif type =~ /\AArray<(.*)>/i
|
126
|
+
# check to ensure the input is an array given that the attribute
|
127
|
+
# is documented as an array but the input is not
|
128
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
129
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
130
|
+
end
|
131
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
132
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
self
|
137
|
+
end
|
138
|
+
|
139
|
+
# Deserializes the data based on type
|
140
|
+
# @param string type Data type
|
141
|
+
# @param string value Value to be deserialized
|
142
|
+
# @return [Object] Deserialized data
|
143
|
+
def _deserialize(type, value)
|
144
|
+
case type.to_sym
|
145
|
+
when :Time
|
146
|
+
Time.parse(value)
|
147
|
+
when :Date
|
148
|
+
Date.parse(value)
|
149
|
+
when :String
|
150
|
+
value.to_s
|
151
|
+
when :Integer
|
152
|
+
value.to_i
|
153
|
+
when :Float
|
154
|
+
value.to_f
|
155
|
+
when :Boolean
|
156
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
157
|
+
true
|
158
|
+
else
|
159
|
+
false
|
160
|
+
end
|
161
|
+
when :Object
|
162
|
+
# generic object (usually a Hash), return directly
|
163
|
+
value
|
164
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
165
|
+
inner_type = Regexp.last_match[:inner_type]
|
166
|
+
value.map { |v| _deserialize(inner_type, v) }
|
167
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
168
|
+
k_type = Regexp.last_match[:k_type]
|
169
|
+
v_type = Regexp.last_match[:v_type]
|
170
|
+
{}.tap do |hash|
|
171
|
+
value.each do |k, v|
|
172
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
173
|
+
end
|
174
|
+
end
|
175
|
+
else # model
|
176
|
+
# models (e.g. Pet) or oneOf
|
177
|
+
klass = UltracartClient.const_get(type)
|
178
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
179
|
+
end
|
180
|
+
end
|
181
|
+
|
182
|
+
# Returns the string representation of the object
|
183
|
+
# @return [String] String presentation of the object
|
184
|
+
def to_s
|
185
|
+
to_hash.to_s
|
186
|
+
end
|
187
|
+
|
188
|
+
# to_body is an alias to to_hash (backward compatibility)
|
189
|
+
# @return [Hash] Returns the object in the form of hash
|
190
|
+
def to_body
|
191
|
+
to_hash
|
192
|
+
end
|
193
|
+
|
194
|
+
# Returns the object in the form of hash
|
195
|
+
# @return [Hash] Returns the object in the form of hash
|
196
|
+
def to_hash
|
197
|
+
hash = {}
|
198
|
+
self.class.attribute_map.each_pair do |attr, param|
|
199
|
+
value = self.send(attr)
|
200
|
+
if value.nil?
|
201
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
202
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
203
|
+
end
|
204
|
+
|
205
|
+
hash[param] = _to_hash(value)
|
206
|
+
end
|
207
|
+
hash
|
208
|
+
end
|
209
|
+
|
210
|
+
# Outputs non-array value in the form of hash
|
211
|
+
# For object, use to_hash. Otherwise, just return the value
|
212
|
+
# @param [Object] value Any valid value
|
213
|
+
# @return [Hash] Returns the value in the form of hash
|
214
|
+
def _to_hash(value)
|
215
|
+
if value.is_a?(Array)
|
216
|
+
value.compact.map { |v| _to_hash(v) }
|
217
|
+
elsif value.is_a?(Hash)
|
218
|
+
{}.tap do |hash|
|
219
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
220
|
+
end
|
221
|
+
elsif value.respond_to? :to_hash
|
222
|
+
value.to_hash
|
223
|
+
else
|
224
|
+
value
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
end
|
229
|
+
|
230
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -666,6 +666,7 @@ require 'ultracart_api/models/order_payment_credit_card_dual_vaulted_property'
|
|
666
666
|
require 'ultracart_api/models/order_payment_e_check'
|
667
667
|
require 'ultracart_api/models/order_payment_health_benefit_card'
|
668
668
|
require 'ultracart_api/models/order_payment_insurance'
|
669
|
+
require 'ultracart_api/models/order_payment_pay_pal'
|
669
670
|
require 'ultracart_api/models/order_payment_purchase_order'
|
670
671
|
require 'ultracart_api/models/order_payment_transaction'
|
671
672
|
require 'ultracart_api/models/order_payment_transaction_detail'
|
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
|
4
|
+
version: 4.1.0
|
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-
|
11
|
+
date: 2025-02-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -725,6 +725,7 @@ files:
|
|
725
725
|
- docs/OrderPaymentECheck.md
|
726
726
|
- docs/OrderPaymentHealthBenefitCard.md
|
727
727
|
- docs/OrderPaymentInsurance.md
|
728
|
+
- docs/OrderPaymentPayPal.md
|
728
729
|
- docs/OrderPaymentPurchaseOrder.md
|
729
730
|
- docs/OrderPaymentTransaction.md
|
730
731
|
- docs/OrderPaymentTransactionDetail.md
|
@@ -1612,6 +1613,7 @@ files:
|
|
1612
1613
|
- lib/ultracart_api/models/order_payment_e_check.rb
|
1613
1614
|
- lib/ultracart_api/models/order_payment_health_benefit_card.rb
|
1614
1615
|
- lib/ultracart_api/models/order_payment_insurance.rb
|
1616
|
+
- lib/ultracart_api/models/order_payment_pay_pal.rb
|
1615
1617
|
- lib/ultracart_api/models/order_payment_purchase_order.rb
|
1616
1618
|
- lib/ultracart_api/models/order_payment_transaction.rb
|
1617
1619
|
- lib/ultracart_api/models/order_payment_transaction_detail.rb
|