ultracart_api 4.1.91 → 4.1.92
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 +6 -2
- data/docs/AutoOrderApi.md +52 -0
- data/docs/AutoOrderCancelReason.md +22 -0
- data/docs/AutoOrderCancelReasonsResponse.md +26 -0
- data/lib/ultracart_api/api/auto_order_api.rb +58 -0
- data/lib/ultracart_api/models/auto_order_cancel_reason.rb +240 -0
- data/lib/ultracart_api/models/auto_order_cancel_reasons_response.rb +259 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a77ef9d44a0fca208587a594a7355963c1c52ce35350ddb2e4485c21c8d6d12b
|
|
4
|
+
data.tar.gz: a883df2b6a0c808186c5f04c258bb0c771375a8c00ad2cf38835e84716a287ef
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ef71a9ca0021da0ddde9395c57b440643e1ee53842090041a39fd9fa4d8da0e666b186cbc8c93e4db4524255bbc5f568f783fcd81bfa00f7d5f152e6084c6f26
|
|
7
|
+
data.tar.gz: 513f17f0460627ec0a7c9e5d4d5ddebc96cca8d4d4477b17cf950a22265445340a93b00d7885f3c61ef2334c2e59e9dd35562ab7d691abd09dd6805993677016
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.92
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.92'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
|
|
|
90
90
|
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
|
91
91
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
|
92
92
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
|
93
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_cancel_reasons**](docs/AutoOrderApi.md#get_auto_order_cancel_reasons) | **GET** /auto_order/auto_orders/cancel_reasons | Retrieve auto order cancel reasons.
|
|
93
94
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_emails**](docs/AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order.
|
|
94
95
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
|
95
96
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
|
@@ -715,6 +716,8 @@ Class | Method | HTTP request | Description
|
|
|
715
716
|
- [UltracartClient::AutoOrderAddonItem](docs/AutoOrderAddonItem.md)
|
|
716
717
|
- [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
|
|
717
718
|
- [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
|
|
719
|
+
- [UltracartClient::AutoOrderCancelReason](docs/AutoOrderCancelReason.md)
|
|
720
|
+
- [UltracartClient::AutoOrderCancelReasonsResponse](docs/AutoOrderCancelReasonsResponse.md)
|
|
718
721
|
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
|
719
722
|
- [UltracartClient::AutoOrderEmail](docs/AutoOrderEmail.md)
|
|
720
723
|
- [UltracartClient::AutoOrderEmailsResponse](docs/AutoOrderEmailsResponse.md)
|
|
@@ -1748,6 +1751,7 @@ Not every change is committed to every SDK.
|
|
|
1748
1751
|
|
|
1749
1752
|
| Version | Date | Comments |
|
|
1750
1753
|
| --: | :-: | --- |
|
|
1754
|
+
| 4.1.92 | 05/26/2026 | AutoOrderApi.getAutoOrderCancelReasons |
|
|
1751
1755
|
| 4.1.91 | 05/18/2026 | ChannelPartner - support creation_dts on import of a store_completed (historical) order |
|
|
1752
1756
|
| 4.1.90 | 05/13/2026 | webhook rest api - new method getWebhookEventCategories |
|
|
1753
1757
|
| 4.1.89 | 05/11/2026 | auto order item level webhooks - cancel scheduled, cancel, pause, reactive, and unpause |
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
10
10
|
| [**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid |
|
|
11
11
|
| [**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code |
|
|
12
12
|
| [**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id |
|
|
13
|
+
| [**get_auto_order_cancel_reasons**](AutoOrderApi.md#get_auto_order_cancel_reasons) | **GET** /auto_order/auto_orders/cancel_reasons | Retrieve auto order cancel reasons. |
|
|
13
14
|
| [**get_auto_order_emails**](AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order. |
|
|
14
15
|
| [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders |
|
|
15
16
|
| [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch |
|
|
@@ -567,6 +568,57 @@ end
|
|
|
567
568
|
- **Accept**: application/json
|
|
568
569
|
|
|
569
570
|
|
|
571
|
+
## get_auto_order_cancel_reasons
|
|
572
|
+
|
|
573
|
+
> <AutoOrderCancelReasonsResponse> get_auto_order_cancel_reasons
|
|
574
|
+
|
|
575
|
+
Retrieve auto order cancel reasons.
|
|
576
|
+
|
|
577
|
+
Retrieves auto order cancel reasons.
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
### Examples
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
(No example for this operation).
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
#### Using the get_auto_order_cancel_reasons_with_http_info variant
|
|
587
|
+
|
|
588
|
+
This returns an Array which contains the response data, status code and headers.
|
|
589
|
+
|
|
590
|
+
> <Array(<AutoOrderCancelReasonsResponse>, Integer, Hash)> get_auto_order_cancel_reasons_with_http_info
|
|
591
|
+
|
|
592
|
+
```ruby
|
|
593
|
+
begin
|
|
594
|
+
# Retrieve auto order cancel reasons.
|
|
595
|
+
data, status_code, headers = api_instance.get_auto_order_cancel_reasons_with_http_info
|
|
596
|
+
p status_code # => 2xx
|
|
597
|
+
p headers # => { ... }
|
|
598
|
+
p data # => <AutoOrderCancelReasonsResponse>
|
|
599
|
+
rescue UltracartClient::ApiError => e
|
|
600
|
+
puts "Error when calling AutoOrderApi->get_auto_order_cancel_reasons_with_http_info: #{e}"
|
|
601
|
+
end
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
### Parameters
|
|
605
|
+
|
|
606
|
+
This endpoint does not need any parameter.
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
[**AutoOrderCancelReasonsResponse**](AutoOrderCancelReasonsResponse.md)
|
|
611
|
+
|
|
612
|
+
### Authorization
|
|
613
|
+
|
|
614
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
615
|
+
|
|
616
|
+
### HTTP request headers
|
|
617
|
+
|
|
618
|
+
- **Content-Type**: Not defined
|
|
619
|
+
- **Accept**: application/json
|
|
620
|
+
|
|
621
|
+
|
|
570
622
|
## get_auto_order_emails
|
|
571
623
|
|
|
572
624
|
> <AutoOrderEmailsResponse> get_auto_order_emails(auto_order_oid)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderCancelReason
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **myaccount_alternate_description** | **String** | MyAccount alternate description | [optional] |
|
|
8
|
+
| **reason** | **String** | Auto order cancel reason | [optional] |
|
|
9
|
+
| **visible_in_myaccount** | **Boolean** | Visible in MyAccount | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::AutoOrderCancelReason.new(
|
|
17
|
+
myaccount_alternate_description: null,
|
|
18
|
+
reason: null,
|
|
19
|
+
visible_in_myaccount: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderCancelReasonsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cancel_reasons** | [**Array<AutoOrderCancelReason>**](AutoOrderCancelReason.md) | cancel_reasons | [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::AutoOrderCancelReasonsResponse.new(
|
|
19
|
+
cancel_reasons: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -458,6 +458,64 @@ module UltracartClient
|
|
|
458
458
|
return data, status_code, headers
|
|
459
459
|
end
|
|
460
460
|
|
|
461
|
+
# Retrieve auto order cancel reasons.
|
|
462
|
+
# Retrieves auto order cancel reasons.
|
|
463
|
+
# @param [Hash] opts the optional parameters
|
|
464
|
+
# @return [AutoOrderCancelReasonsResponse]
|
|
465
|
+
def get_auto_order_cancel_reasons(opts = {})
|
|
466
|
+
data, _status_code, _headers = get_auto_order_cancel_reasons_with_http_info(opts)
|
|
467
|
+
data
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
# Retrieve auto order cancel reasons.
|
|
471
|
+
# Retrieves auto order cancel reasons.
|
|
472
|
+
# @param [Hash] opts the optional parameters
|
|
473
|
+
# @return [Array<(AutoOrderCancelReasonsResponse, Integer, Hash)>] AutoOrderCancelReasonsResponse data, response status code and response headers
|
|
474
|
+
def get_auto_order_cancel_reasons_with_http_info(opts = {})
|
|
475
|
+
if @api_client.config.debugging
|
|
476
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.get_auto_order_cancel_reasons ...'
|
|
477
|
+
end
|
|
478
|
+
# resource path
|
|
479
|
+
local_var_path = '/auto_order/auto_orders/cancel_reasons'
|
|
480
|
+
|
|
481
|
+
# query parameters
|
|
482
|
+
query_params = opts[:query_params] || {}
|
|
483
|
+
|
|
484
|
+
# header parameters
|
|
485
|
+
header_params = opts[:header_params] || {}
|
|
486
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
487
|
+
# HTTP header 'Accept' (if needed)
|
|
488
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
489
|
+
|
|
490
|
+
# form parameters
|
|
491
|
+
form_params = opts[:form_params] || {}
|
|
492
|
+
|
|
493
|
+
# http body (model)
|
|
494
|
+
post_body = opts[:debug_body]
|
|
495
|
+
|
|
496
|
+
# return_type
|
|
497
|
+
return_type = opts[:debug_return_type] || 'AutoOrderCancelReasonsResponse'
|
|
498
|
+
|
|
499
|
+
# auth_names
|
|
500
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
501
|
+
|
|
502
|
+
new_options = opts.merge(
|
|
503
|
+
:operation => :"AutoOrderApi.get_auto_order_cancel_reasons",
|
|
504
|
+
:header_params => header_params,
|
|
505
|
+
:query_params => query_params,
|
|
506
|
+
:form_params => form_params,
|
|
507
|
+
:body => post_body,
|
|
508
|
+
:auth_names => auth_names,
|
|
509
|
+
:return_type => return_type
|
|
510
|
+
)
|
|
511
|
+
|
|
512
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
513
|
+
if @api_client.config.debugging
|
|
514
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#get_auto_order_cancel_reasons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
515
|
+
end
|
|
516
|
+
return data, status_code, headers
|
|
517
|
+
end
|
|
518
|
+
|
|
461
519
|
# Retrieve email delivery information for this auto order.
|
|
462
520
|
# Retrieves email delivery records associated with the specified auto order.
|
|
463
521
|
# @param auto_order_oid [Integer] The auto order oid to retrieve email delivery information for.
|
|
@@ -0,0 +1,240 @@
|
|
|
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 AutoOrderCancelReason
|
|
18
|
+
# MyAccount alternate description
|
|
19
|
+
attr_accessor :myaccount_alternate_description
|
|
20
|
+
|
|
21
|
+
# Auto order cancel reason
|
|
22
|
+
attr_accessor :reason
|
|
23
|
+
|
|
24
|
+
# Visible in MyAccount
|
|
25
|
+
attr_accessor :visible_in_myaccount
|
|
26
|
+
|
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
28
|
+
def self.attribute_map
|
|
29
|
+
{
|
|
30
|
+
:'myaccount_alternate_description' => :'myaccount_alternate_description',
|
|
31
|
+
:'reason' => :'reason',
|
|
32
|
+
:'visible_in_myaccount' => :'visible_in_myaccount'
|
|
33
|
+
}
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Returns all the JSON keys this model knows about
|
|
37
|
+
def self.acceptable_attributes
|
|
38
|
+
attribute_map.values
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Attribute type mapping.
|
|
42
|
+
def self.openapi_types
|
|
43
|
+
{
|
|
44
|
+
:'myaccount_alternate_description' => :'String',
|
|
45
|
+
:'reason' => :'String',
|
|
46
|
+
:'visible_in_myaccount' => :'Boolean'
|
|
47
|
+
}
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# List of attributes with nullable: true
|
|
51
|
+
def self.openapi_nullable
|
|
52
|
+
Set.new([
|
|
53
|
+
])
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Initializes the object
|
|
57
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
58
|
+
def initialize(attributes = {})
|
|
59
|
+
if (!attributes.is_a?(Hash))
|
|
60
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::AutoOrderCancelReason` initialize method"
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
64
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
65
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
66
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::AutoOrderCancelReason`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
67
|
+
end
|
|
68
|
+
h[k.to_sym] = v
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
if attributes.key?(:'myaccount_alternate_description')
|
|
72
|
+
self.myaccount_alternate_description = attributes[:'myaccount_alternate_description']
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
if attributes.key?(:'reason')
|
|
76
|
+
self.reason = attributes[:'reason']
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if attributes.key?(:'visible_in_myaccount')
|
|
80
|
+
self.visible_in_myaccount = attributes[:'visible_in_myaccount']
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
85
|
+
# @return Array for valid properties with the reasons
|
|
86
|
+
def list_invalid_properties
|
|
87
|
+
invalid_properties = Array.new
|
|
88
|
+
invalid_properties
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Check to see if the all the properties in the model are valid
|
|
92
|
+
# @return true if the model is valid
|
|
93
|
+
def valid?
|
|
94
|
+
true
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# Checks equality by comparing each attribute.
|
|
98
|
+
# @param [Object] Object to be compared
|
|
99
|
+
def ==(o)
|
|
100
|
+
return true if self.equal?(o)
|
|
101
|
+
self.class == o.class &&
|
|
102
|
+
myaccount_alternate_description == o.myaccount_alternate_description &&
|
|
103
|
+
reason == o.reason &&
|
|
104
|
+
visible_in_myaccount == o.visible_in_myaccount
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# @see the `==` method
|
|
108
|
+
# @param [Object] Object to be compared
|
|
109
|
+
def eql?(o)
|
|
110
|
+
self == o
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Calculates hash code according to all attributes.
|
|
114
|
+
# @return [Integer] Hash code
|
|
115
|
+
def hash
|
|
116
|
+
[myaccount_alternate_description, reason, visible_in_myaccount].hash
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Builds the object from hash
|
|
120
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
121
|
+
# @return [Object] Returns the model itself
|
|
122
|
+
def self.build_from_hash(attributes)
|
|
123
|
+
new.build_from_hash(attributes)
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# Builds the object from hash
|
|
127
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
128
|
+
# @return [Object] Returns the model itself
|
|
129
|
+
def build_from_hash(attributes)
|
|
130
|
+
return nil unless attributes.is_a?(Hash)
|
|
131
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
132
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
133
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
134
|
+
self.send("#{key}=", nil)
|
|
135
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
136
|
+
# check to ensure the input is an array given that the attribute
|
|
137
|
+
# is documented as an array but the input is not
|
|
138
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
139
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
140
|
+
end
|
|
141
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
142
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
self
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Deserializes the data based on type
|
|
150
|
+
# @param string type Data type
|
|
151
|
+
# @param string value Value to be deserialized
|
|
152
|
+
# @return [Object] Deserialized data
|
|
153
|
+
def _deserialize(type, value)
|
|
154
|
+
case type.to_sym
|
|
155
|
+
when :Time
|
|
156
|
+
Time.parse(value)
|
|
157
|
+
when :Date
|
|
158
|
+
Date.parse(value)
|
|
159
|
+
when :String
|
|
160
|
+
value.to_s
|
|
161
|
+
when :Integer
|
|
162
|
+
value.to_i
|
|
163
|
+
when :Float
|
|
164
|
+
value.to_f
|
|
165
|
+
when :Boolean
|
|
166
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
167
|
+
true
|
|
168
|
+
else
|
|
169
|
+
false
|
|
170
|
+
end
|
|
171
|
+
when :Object
|
|
172
|
+
# generic object (usually a Hash), return directly
|
|
173
|
+
value
|
|
174
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
175
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
176
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
177
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
178
|
+
k_type = Regexp.last_match[:k_type]
|
|
179
|
+
v_type = Regexp.last_match[:v_type]
|
|
180
|
+
{}.tap do |hash|
|
|
181
|
+
value.each do |k, v|
|
|
182
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
else # model
|
|
186
|
+
# models (e.g. Pet) or oneOf
|
|
187
|
+
klass = UltracartClient.const_get(type)
|
|
188
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Returns the string representation of the object
|
|
193
|
+
# @return [String] String presentation of the object
|
|
194
|
+
def to_s
|
|
195
|
+
to_hash.to_s
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
199
|
+
# @return [Hash] Returns the object in the form of hash
|
|
200
|
+
def to_body
|
|
201
|
+
to_hash
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
# Returns the object in the form of hash
|
|
205
|
+
# @return [Hash] Returns the object in the form of hash
|
|
206
|
+
def to_hash
|
|
207
|
+
hash = {}
|
|
208
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
209
|
+
value = self.send(attr)
|
|
210
|
+
if value.nil?
|
|
211
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
212
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
hash[param] = _to_hash(value)
|
|
216
|
+
end
|
|
217
|
+
hash
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Outputs non-array value in the form of hash
|
|
221
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
222
|
+
# @param [Object] value Any valid value
|
|
223
|
+
# @return [Hash] Returns the value in the form of hash
|
|
224
|
+
def _to_hash(value)
|
|
225
|
+
if value.is_a?(Array)
|
|
226
|
+
value.compact.map { |v| _to_hash(v) }
|
|
227
|
+
elsif value.is_a?(Hash)
|
|
228
|
+
{}.tap do |hash|
|
|
229
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
230
|
+
end
|
|
231
|
+
elsif value.respond_to? :to_hash
|
|
232
|
+
value.to_hash
|
|
233
|
+
else
|
|
234
|
+
value
|
|
235
|
+
end
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
end
|
|
239
|
+
|
|
240
|
+
end
|
|
@@ -0,0 +1,259 @@
|
|
|
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 AutoOrderCancelReasonsResponse
|
|
18
|
+
# cancel_reasons
|
|
19
|
+
attr_accessor :cancel_reasons
|
|
20
|
+
|
|
21
|
+
attr_accessor :error
|
|
22
|
+
|
|
23
|
+
attr_accessor :metadata
|
|
24
|
+
|
|
25
|
+
# Indicates if API call was successful
|
|
26
|
+
attr_accessor :success
|
|
27
|
+
|
|
28
|
+
attr_accessor :warning
|
|
29
|
+
|
|
30
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
31
|
+
def self.attribute_map
|
|
32
|
+
{
|
|
33
|
+
:'cancel_reasons' => :'cancelReasons',
|
|
34
|
+
:'error' => :'error',
|
|
35
|
+
:'metadata' => :'metadata',
|
|
36
|
+
:'success' => :'success',
|
|
37
|
+
:'warning' => :'warning'
|
|
38
|
+
}
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Returns all the JSON keys this model knows about
|
|
42
|
+
def self.acceptable_attributes
|
|
43
|
+
attribute_map.values
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Attribute type mapping.
|
|
47
|
+
def self.openapi_types
|
|
48
|
+
{
|
|
49
|
+
:'cancel_reasons' => :'Array<AutoOrderCancelReason>',
|
|
50
|
+
:'error' => :'Error',
|
|
51
|
+
:'metadata' => :'ResponseMetadata',
|
|
52
|
+
:'success' => :'Boolean',
|
|
53
|
+
:'warning' => :'Warning'
|
|
54
|
+
}
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# List of attributes with nullable: true
|
|
58
|
+
def self.openapi_nullable
|
|
59
|
+
Set.new([
|
|
60
|
+
])
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Initializes the object
|
|
64
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
65
|
+
def initialize(attributes = {})
|
|
66
|
+
if (!attributes.is_a?(Hash))
|
|
67
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::AutoOrderCancelReasonsResponse` initialize method"
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
71
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
72
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::AutoOrderCancelReasonsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
74
|
+
end
|
|
75
|
+
h[k.to_sym] = v
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
if attributes.key?(:'cancel_reasons')
|
|
79
|
+
if (value = attributes[:'cancel_reasons']).is_a?(Array)
|
|
80
|
+
self.cancel_reasons = value
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
if attributes.key?(:'error')
|
|
85
|
+
self.error = attributes[:'error']
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
if attributes.key?(:'metadata')
|
|
89
|
+
self.metadata = attributes[:'metadata']
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
if attributes.key?(:'success')
|
|
93
|
+
self.success = attributes[:'success']
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
if attributes.key?(:'warning')
|
|
97
|
+
self.warning = attributes[:'warning']
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
102
|
+
# @return Array for valid properties with the reasons
|
|
103
|
+
def list_invalid_properties
|
|
104
|
+
invalid_properties = Array.new
|
|
105
|
+
invalid_properties
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Check to see if the all the properties in the model are valid
|
|
109
|
+
# @return true if the model is valid
|
|
110
|
+
def valid?
|
|
111
|
+
true
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Checks equality by comparing each attribute.
|
|
115
|
+
# @param [Object] Object to be compared
|
|
116
|
+
def ==(o)
|
|
117
|
+
return true if self.equal?(o)
|
|
118
|
+
self.class == o.class &&
|
|
119
|
+
cancel_reasons == o.cancel_reasons &&
|
|
120
|
+
error == o.error &&
|
|
121
|
+
metadata == o.metadata &&
|
|
122
|
+
success == o.success &&
|
|
123
|
+
warning == o.warning
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# @see the `==` method
|
|
127
|
+
# @param [Object] Object to be compared
|
|
128
|
+
def eql?(o)
|
|
129
|
+
self == o
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Calculates hash code according to all attributes.
|
|
133
|
+
# @return [Integer] Hash code
|
|
134
|
+
def hash
|
|
135
|
+
[cancel_reasons, error, metadata, success, warning].hash
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Builds the object from hash
|
|
139
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
140
|
+
# @return [Object] Returns the model itself
|
|
141
|
+
def self.build_from_hash(attributes)
|
|
142
|
+
new.build_from_hash(attributes)
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Builds the object from hash
|
|
146
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
147
|
+
# @return [Object] Returns the model itself
|
|
148
|
+
def build_from_hash(attributes)
|
|
149
|
+
return nil unless attributes.is_a?(Hash)
|
|
150
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
151
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
152
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
153
|
+
self.send("#{key}=", nil)
|
|
154
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
155
|
+
# check to ensure the input is an array given that the attribute
|
|
156
|
+
# is documented as an array but the input is not
|
|
157
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
158
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
159
|
+
end
|
|
160
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
161
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
self
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Deserializes the data based on type
|
|
169
|
+
# @param string type Data type
|
|
170
|
+
# @param string value Value to be deserialized
|
|
171
|
+
# @return [Object] Deserialized data
|
|
172
|
+
def _deserialize(type, value)
|
|
173
|
+
case type.to_sym
|
|
174
|
+
when :Time
|
|
175
|
+
Time.parse(value)
|
|
176
|
+
when :Date
|
|
177
|
+
Date.parse(value)
|
|
178
|
+
when :String
|
|
179
|
+
value.to_s
|
|
180
|
+
when :Integer
|
|
181
|
+
value.to_i
|
|
182
|
+
when :Float
|
|
183
|
+
value.to_f
|
|
184
|
+
when :Boolean
|
|
185
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
186
|
+
true
|
|
187
|
+
else
|
|
188
|
+
false
|
|
189
|
+
end
|
|
190
|
+
when :Object
|
|
191
|
+
# generic object (usually a Hash), return directly
|
|
192
|
+
value
|
|
193
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
194
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
195
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
196
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
197
|
+
k_type = Regexp.last_match[:k_type]
|
|
198
|
+
v_type = Regexp.last_match[:v_type]
|
|
199
|
+
{}.tap do |hash|
|
|
200
|
+
value.each do |k, v|
|
|
201
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
else # model
|
|
205
|
+
# models (e.g. Pet) or oneOf
|
|
206
|
+
klass = UltracartClient.const_get(type)
|
|
207
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
# Returns the string representation of the object
|
|
212
|
+
# @return [String] String presentation of the object
|
|
213
|
+
def to_s
|
|
214
|
+
to_hash.to_s
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
218
|
+
# @return [Hash] Returns the object in the form of hash
|
|
219
|
+
def to_body
|
|
220
|
+
to_hash
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
# Returns the object in the form of hash
|
|
224
|
+
# @return [Hash] Returns the object in the form of hash
|
|
225
|
+
def to_hash
|
|
226
|
+
hash = {}
|
|
227
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
228
|
+
value = self.send(attr)
|
|
229
|
+
if value.nil?
|
|
230
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
231
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
hash[param] = _to_hash(value)
|
|
235
|
+
end
|
|
236
|
+
hash
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
# Outputs non-array value in the form of hash
|
|
240
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
241
|
+
# @param [Object] value Any valid value
|
|
242
|
+
# @return [Hash] Returns the value in the form of hash
|
|
243
|
+
def _to_hash(value)
|
|
244
|
+
if value.is_a?(Array)
|
|
245
|
+
value.compact.map { |v| _to_hash(v) }
|
|
246
|
+
elsif value.is_a?(Hash)
|
|
247
|
+
{}.tap do |hash|
|
|
248
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
249
|
+
end
|
|
250
|
+
elsif value.respond_to? :to_hash
|
|
251
|
+
value.to_hash
|
|
252
|
+
else
|
|
253
|
+
value
|
|
254
|
+
end
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -44,6 +44,8 @@ require 'ultracart_api/models/auto_order'
|
|
|
44
44
|
require 'ultracart_api/models/auto_order_addon_item'
|
|
45
45
|
require 'ultracart_api/models/auto_order_addon_item_option'
|
|
46
46
|
require 'ultracart_api/models/auto_order_addon_items_update_request'
|
|
47
|
+
require 'ultracart_api/models/auto_order_cancel_reason'
|
|
48
|
+
require 'ultracart_api/models/auto_order_cancel_reasons_response'
|
|
47
49
|
require 'ultracart_api/models/auto_order_consolidate'
|
|
48
50
|
require 'ultracart_api/models/auto_order_email'
|
|
49
51
|
require 'ultracart_api/models/auto_order_emails_response'
|
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.1.
|
|
4
|
+
version: 4.1.92
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-05-
|
|
11
|
+
date: 2026-05-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -90,6 +90,8 @@ files:
|
|
|
90
90
|
- docs/AutoOrderAddonItemOption.md
|
|
91
91
|
- docs/AutoOrderAddonItemsUpdateRequest.md
|
|
92
92
|
- docs/AutoOrderApi.md
|
|
93
|
+
- docs/AutoOrderCancelReason.md
|
|
94
|
+
- docs/AutoOrderCancelReasonsResponse.md
|
|
93
95
|
- docs/AutoOrderConsolidate.md
|
|
94
96
|
- docs/AutoOrderEmail.md
|
|
95
97
|
- docs/AutoOrderEmailsResponse.md
|
|
@@ -1120,6 +1122,8 @@ files:
|
|
|
1120
1122
|
- lib/ultracart_api/models/auto_order_addon_item.rb
|
|
1121
1123
|
- lib/ultracart_api/models/auto_order_addon_item_option.rb
|
|
1122
1124
|
- lib/ultracart_api/models/auto_order_addon_items_update_request.rb
|
|
1125
|
+
- lib/ultracart_api/models/auto_order_cancel_reason.rb
|
|
1126
|
+
- lib/ultracart_api/models/auto_order_cancel_reasons_response.rb
|
|
1123
1127
|
- lib/ultracart_api/models/auto_order_consolidate.rb
|
|
1124
1128
|
- lib/ultracart_api/models/auto_order_email.rb
|
|
1125
1129
|
- lib/ultracart_api/models/auto_order_emails_response.rb
|