ultracart_api 4.1.18 → 4.1.19

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: 608097960d36f44a87222e211204808a5e6e5d4cd424893aade7ca4b9df44a19
4
- data.tar.gz: 647dcf56829dc2ad988d87819aa122dd806890ae8a4d9757cbbac8a1c28319d0
3
+ metadata.gz: bf4f0f443fba101644631578caee41d31441e25038029b0aae3af0980c606423
4
+ data.tar.gz: 125cb90320949b40091252e04d71e0739091e36e9dc2a8d36222868bef61c35e
5
5
  SHA512:
6
- metadata.gz: e724414081b88762ef4e9c0b05417b5fb749df199a46f5a81d35a242ec7bfa056291acb51e253b08bf5619283a7bb5bf9fb66281b169cc6b7459b01cb0e71184
7
- data.tar.gz: 35b55506a3f6c3217e0f6fd121aa376198ed22d86402479da4331ba71869396107eec2d87dfe897b053430a2f1d9b109b63f4b1a2c2a685cb08ad688f8a6cf37
6
+ metadata.gz: 3f9e8c5f1872a797be00dfc6aad1f48264ce8f8ce32b494b5b4ce593011ab88a7b9c5ad7b511817a227a109d1979b224bb1595068b99c38e5b2ad27b89871b8d
7
+ data.tar.gz: 935084f2cf39b7b0fa93e501d7b1467353aa261ed8d61999966df3cbcfde095be4c3317100f8dbc9621ec596da58aceb9e9dce652919e12a4b580a595241aeda
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.18
10
+ - Package version: 4.1.19
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.18'
19
+ gem 'ultracart_api', '4.1.19'
20
20
  ```
21
21
 
22
22
  install:
@@ -832,6 +832,7 @@ Class | Method | HTTP request | Description
832
832
  - [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
833
833
  - [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
834
834
  - [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
835
+ - [UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment](docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md)
835
836
  - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
836
837
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
837
838
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
@@ -913,6 +914,7 @@ Class | Method | HTTP request | Description
913
914
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
914
915
  - [UltracartClient::Currency](docs/Currency.md)
915
916
  - [UltracartClient::CustomDashboard](docs/CustomDashboard.md)
917
+ - [UltracartClient::CustomDashboardExecutionParameter](docs/CustomDashboardExecutionParameter.md)
916
918
  - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
917
919
  - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
918
920
  - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
@@ -1567,6 +1569,7 @@ Not every change is committed to every SDK.
1567
1569
 
1568
1570
  | Version | Date | Comments |
1569
1571
  | --: | :-: | --- |
1572
+ | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
1570
1573
  | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
1571
1574
  | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
1572
1575
  | 4.1.16 | 07/28/2025 | updated doc samples |
@@ -11,10 +11,13 @@
11
11
  | **open_support_ticket** | **Boolean** | | [optional] |
12
12
  | **open_support_ticket_channel** | **String** | Channel to use to open the support ticket | [optional] |
13
13
  | **open_support_ticket_channel_email** | **String** | Email to send support ticket to | [optional] |
14
+ | **open_support_ticket_zoho_desk_department_id** | **String** | Department ID to open a Zoho Desk ticket for | [optional] |
14
15
  | **pause_subscription** | **Boolean** | | [optional] |
15
16
  | **resume_subscription** | **Boolean** | | [optional] |
16
17
  | **transfer_chat_to_live_agent** | **Boolean** | | [optional] |
17
18
  | **update_subscription_credit_card** | **Boolean** | | [optional] |
19
+ | **zoho_desk_available** | **Boolean** | True if Zoho Desk is connected to UltraCart | [optional] |
20
+ | **zoho_desk_departments** | [**Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>**](ConversationVirtualAgentCapabilityZohoDeskDepartment.md) | Array of Zoho Desk Department if zoho desk is connected to UltraCart | [optional] |
18
21
 
19
22
  ## Example
20
23
 
@@ -29,10 +32,13 @@ instance = UltracartClient::ConversationVirtualAgentCapabilities.new(
29
32
  open_support_ticket: null,
30
33
  open_support_ticket_channel: null,
31
34
  open_support_ticket_channel_email: null,
35
+ open_support_ticket_zoho_desk_department_id: null,
32
36
  pause_subscription: null,
33
37
  resume_subscription: null,
34
38
  transfer_chat_to_live_agent: null,
35
- update_subscription_credit_card: null
39
+ update_subscription_credit_card: null,
40
+ zoho_desk_available: null,
41
+ zoho_desk_departments: null
36
42
  )
37
43
  ```
38
44
 
@@ -0,0 +1,20 @@
1
+ # UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **department_id** | **String** | | [optional] |
8
+ | **department_name** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment.new(
16
+ department_id: null,
17
+ department_name: null
18
+ )
19
+ ```
20
+
@@ -8,6 +8,7 @@
8
8
  | **merchant_id** | **String** | | [optional] |
9
9
  | **name** | **String** | | [optional] |
10
10
  | **pages** | [**Array<CustomDashboardPage>**](CustomDashboardPage.md) | | [optional] |
11
+ | **parameters** | [**Array<CustomDashboardExecutionParameter>**](CustomDashboardExecutionParameter.md) | | [optional] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = UltracartClient::CustomDashboard.new(
18
19
  data_warehouse_custom_dashboard_oid: null,
19
20
  merchant_id: null,
20
21
  name: null,
21
- pages: null
22
+ pages: null,
23
+ parameters: null
22
24
  )
23
25
  ```
24
26
 
@@ -0,0 +1,24 @@
1
+ # UltracartClient::CustomDashboardExecutionParameter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **quick_pick_key** | **String** | | [optional] |
9
+ | **type** | **String** | | [optional] |
10
+ | **value** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::CustomDashboardExecutionParameter.new(
18
+ name: null,
19
+ quick_pick_key: null,
20
+ type: null,
21
+ value: null
22
+ )
23
+ ```
24
+
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | | [optional] |
8
+ | **quick_pick_key** | **String** | | [optional] |
8
9
  | **type** | **String** | | [optional] |
9
10
  | **value** | **String** | | [optional] |
10
11
 
@@ -15,6 +16,7 @@ require 'ultracart_api'
15
16
 
16
17
  instance = UltracartClient::CustomReportExecutionParameter.new(
17
18
  name: null,
19
+ quick_pick_key: null,
18
20
  type: null,
19
21
  value: null
20
22
  )
@@ -31,6 +31,9 @@ module UltracartClient
31
31
  # Email to send support ticket to
32
32
  attr_accessor :open_support_ticket_channel_email
33
33
 
34
+ # Department ID to open a Zoho Desk ticket for
35
+ attr_accessor :open_support_ticket_zoho_desk_department_id
36
+
34
37
  attr_accessor :pause_subscription
35
38
 
36
39
  attr_accessor :resume_subscription
@@ -39,6 +42,12 @@ module UltracartClient
39
42
 
40
43
  attr_accessor :update_subscription_credit_card
41
44
 
45
+ # True if Zoho Desk is connected to UltraCart
46
+ attr_accessor :zoho_desk_available
47
+
48
+ # Array of Zoho Desk Department if zoho desk is connected to UltraCart
49
+ attr_accessor :zoho_desk_departments
50
+
42
51
  class EnumAttributeValidator
43
52
  attr_reader :datatype
44
53
  attr_reader :allowable_values
@@ -71,10 +80,13 @@ module UltracartClient
71
80
  :'open_support_ticket' => :'open_support_ticket',
72
81
  :'open_support_ticket_channel' => :'open_support_ticket_channel',
73
82
  :'open_support_ticket_channel_email' => :'open_support_ticket_channel_email',
83
+ :'open_support_ticket_zoho_desk_department_id' => :'open_support_ticket_zoho_desk_department_id',
74
84
  :'pause_subscription' => :'pause_subscription',
75
85
  :'resume_subscription' => :'resume_subscription',
76
86
  :'transfer_chat_to_live_agent' => :'transfer_chat_to_live_agent',
77
- :'update_subscription_credit_card' => :'update_subscription_credit_card'
87
+ :'update_subscription_credit_card' => :'update_subscription_credit_card',
88
+ :'zoho_desk_available' => :'zoho_desk_available',
89
+ :'zoho_desk_departments' => :'zoho_desk_departments'
78
90
  }
79
91
  end
80
92
 
@@ -93,10 +105,13 @@ module UltracartClient
93
105
  :'open_support_ticket' => :'Boolean',
94
106
  :'open_support_ticket_channel' => :'String',
95
107
  :'open_support_ticket_channel_email' => :'String',
108
+ :'open_support_ticket_zoho_desk_department_id' => :'String',
96
109
  :'pause_subscription' => :'Boolean',
97
110
  :'resume_subscription' => :'Boolean',
98
111
  :'transfer_chat_to_live_agent' => :'Boolean',
99
- :'update_subscription_credit_card' => :'Boolean'
112
+ :'update_subscription_credit_card' => :'Boolean',
113
+ :'zoho_desk_available' => :'Boolean',
114
+ :'zoho_desk_departments' => :'Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>'
100
115
  }
101
116
  end
102
117
 
@@ -149,6 +164,10 @@ module UltracartClient
149
164
  self.open_support_ticket_channel_email = attributes[:'open_support_ticket_channel_email']
150
165
  end
151
166
 
167
+ if attributes.key?(:'open_support_ticket_zoho_desk_department_id')
168
+ self.open_support_ticket_zoho_desk_department_id = attributes[:'open_support_ticket_zoho_desk_department_id']
169
+ end
170
+
152
171
  if attributes.key?(:'pause_subscription')
153
172
  self.pause_subscription = attributes[:'pause_subscription']
154
173
  end
@@ -164,6 +183,16 @@ module UltracartClient
164
183
  if attributes.key?(:'update_subscription_credit_card')
165
184
  self.update_subscription_credit_card = attributes[:'update_subscription_credit_card']
166
185
  end
186
+
187
+ if attributes.key?(:'zoho_desk_available')
188
+ self.zoho_desk_available = attributes[:'zoho_desk_available']
189
+ end
190
+
191
+ if attributes.key?(:'zoho_desk_departments')
192
+ if (value = attributes[:'zoho_desk_departments']).is_a?(Array)
193
+ self.zoho_desk_departments = value
194
+ end
195
+ end
167
196
  end
168
197
 
169
198
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -176,7 +205,7 @@ module UltracartClient
176
205
  # Check to see if the all the properties in the model are valid
177
206
  # @return true if the model is valid
178
207
  def valid?
179
- open_support_ticket_channel_validator = EnumAttributeValidator.new('String', ["none", "email", "UltraCart Task", "Zoho Desk Ticket"])
208
+ open_support_ticket_channel_validator = EnumAttributeValidator.new('String', ["none", "email", "ultracart_task", "zoho_desk_ticket"])
180
209
  return false unless open_support_ticket_channel_validator.valid?(@open_support_ticket_channel)
181
210
  true
182
211
  end
@@ -184,7 +213,7 @@ module UltracartClient
184
213
  # Custom attribute writer method checking allowed values (enum).
185
214
  # @param [Object] open_support_ticket_channel Object to be assigned
186
215
  def open_support_ticket_channel=(open_support_ticket_channel)
187
- validator = EnumAttributeValidator.new('String', ["none", "email", "UltraCart Task", "Zoho Desk Ticket"])
216
+ validator = EnumAttributeValidator.new('String', ["none", "email", "ultracart_task", "zoho_desk_ticket"])
188
217
  unless validator.valid?(open_support_ticket_channel)
189
218
  fail ArgumentError, "invalid value for \"open_support_ticket_channel\", must be one of #{validator.allowable_values}."
190
219
  end
@@ -203,10 +232,13 @@ module UltracartClient
203
232
  open_support_ticket == o.open_support_ticket &&
204
233
  open_support_ticket_channel == o.open_support_ticket_channel &&
205
234
  open_support_ticket_channel_email == o.open_support_ticket_channel_email &&
235
+ open_support_ticket_zoho_desk_department_id == o.open_support_ticket_zoho_desk_department_id &&
206
236
  pause_subscription == o.pause_subscription &&
207
237
  resume_subscription == o.resume_subscription &&
208
238
  transfer_chat_to_live_agent == o.transfer_chat_to_live_agent &&
209
- update_subscription_credit_card == o.update_subscription_credit_card
239
+ update_subscription_credit_card == o.update_subscription_credit_card &&
240
+ zoho_desk_available == o.zoho_desk_available &&
241
+ zoho_desk_departments == o.zoho_desk_departments
210
242
  end
211
243
 
212
244
  # @see the `==` method
@@ -218,7 +250,7 @@ module UltracartClient
218
250
  # Calculates hash code according to all attributes.
219
251
  # @return [Integer] Hash code
220
252
  def hash
221
- [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card].hash
253
+ [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
222
254
  end
223
255
 
224
256
  # Builds the object from hash
@@ -0,0 +1,228 @@
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 ConversationVirtualAgentCapabilityZohoDeskDepartment
18
+ attr_accessor :department_id
19
+
20
+ attr_accessor :department_name
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'department_id' => :'department_id',
26
+ :'department_name' => :'department_name'
27
+ }
28
+ end
29
+
30
+ # Returns all the JSON keys this model knows about
31
+ def self.acceptable_attributes
32
+ attribute_map.values
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.openapi_types
37
+ {
38
+ :'department_id' => :'String',
39
+ :'department_name' => :'String'
40
+ }
41
+ end
42
+
43
+ # List of attributes with nullable: true
44
+ def self.openapi_nullable
45
+ Set.new([
46
+ ])
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ if (!attributes.is_a?(Hash))
53
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment` initialize method"
54
+ end
55
+
56
+ # check to see if the attribute exists and convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h|
58
+ if (!self.class.attribute_map.key?(k.to_sym))
59
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
+ end
61
+ h[k.to_sym] = v
62
+ }
63
+
64
+ if attributes.key?(:'department_id')
65
+ self.department_id = attributes[:'department_id']
66
+ end
67
+
68
+ if attributes.key?(:'department_name')
69
+ self.department_name = attributes[:'department_name']
70
+ end
71
+ end
72
+
73
+ # Show invalid properties with the reasons. Usually used together with valid?
74
+ # @return Array for valid properties with the reasons
75
+ def list_invalid_properties
76
+ invalid_properties = Array.new
77
+ invalid_properties
78
+ end
79
+
80
+ # Check to see if the all the properties in the model are valid
81
+ # @return true if the model is valid
82
+ def valid?
83
+ true
84
+ end
85
+
86
+ # Checks equality by comparing each attribute.
87
+ # @param [Object] Object to be compared
88
+ def ==(o)
89
+ return true if self.equal?(o)
90
+ self.class == o.class &&
91
+ department_id == o.department_id &&
92
+ department_name == o.department_name
93
+ end
94
+
95
+ # @see the `==` method
96
+ # @param [Object] Object to be compared
97
+ def eql?(o)
98
+ self == o
99
+ end
100
+
101
+ # Calculates hash code according to all attributes.
102
+ # @return [Integer] Hash code
103
+ def hash
104
+ [department_id, department_name].hash
105
+ end
106
+
107
+ # Builds the object from hash
108
+ # @param [Hash] attributes Model attributes in the form of hash
109
+ # @return [Object] Returns the model itself
110
+ def self.build_from_hash(attributes)
111
+ new.build_from_hash(attributes)
112
+ end
113
+
114
+ # Builds the object from hash
115
+ # @param [Hash] attributes Model attributes in the form of hash
116
+ # @return [Object] Returns the model itself
117
+ def build_from_hash(attributes)
118
+ return nil unless attributes.is_a?(Hash)
119
+ attributes = attributes.transform_keys(&:to_sym)
120
+ self.class.openapi_types.each_pair do |key, type|
121
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
122
+ self.send("#{key}=", nil)
123
+ elsif type =~ /\AArray<(.*)>/i
124
+ # check to ensure the input is an array given that the attribute
125
+ # is documented as an array but the input is not
126
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
127
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
128
+ end
129
+ elsif !attributes[self.class.attribute_map[key]].nil?
130
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
131
+ end
132
+ end
133
+
134
+ self
135
+ end
136
+
137
+ # Deserializes the data based on type
138
+ # @param string type Data type
139
+ # @param string value Value to be deserialized
140
+ # @return [Object] Deserialized data
141
+ def _deserialize(type, value)
142
+ case type.to_sym
143
+ when :Time
144
+ Time.parse(value)
145
+ when :Date
146
+ Date.parse(value)
147
+ when :String
148
+ value.to_s
149
+ when :Integer
150
+ value.to_i
151
+ when :Float
152
+ value.to_f
153
+ when :Boolean
154
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
155
+ true
156
+ else
157
+ false
158
+ end
159
+ when :Object
160
+ # generic object (usually a Hash), return directly
161
+ value
162
+ when /\AArray<(?<inner_type>.+)>\z/
163
+ inner_type = Regexp.last_match[:inner_type]
164
+ value.map { |v| _deserialize(inner_type, v) }
165
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
166
+ k_type = Regexp.last_match[:k_type]
167
+ v_type = Regexp.last_match[:v_type]
168
+ {}.tap do |hash|
169
+ value.each do |k, v|
170
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
171
+ end
172
+ end
173
+ else # model
174
+ # models (e.g. Pet) or oneOf
175
+ klass = UltracartClient.const_get(type)
176
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
177
+ end
178
+ end
179
+
180
+ # Returns the string representation of the object
181
+ # @return [String] String presentation of the object
182
+ def to_s
183
+ to_hash.to_s
184
+ end
185
+
186
+ # to_body is an alias to to_hash (backward compatibility)
187
+ # @return [Hash] Returns the object in the form of hash
188
+ def to_body
189
+ to_hash
190
+ end
191
+
192
+ # Returns the object in the form of hash
193
+ # @return [Hash] Returns the object in the form of hash
194
+ def to_hash
195
+ hash = {}
196
+ self.class.attribute_map.each_pair do |attr, param|
197
+ value = self.send(attr)
198
+ if value.nil?
199
+ is_nullable = self.class.openapi_nullable.include?(attr)
200
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
201
+ end
202
+
203
+ hash[param] = _to_hash(value)
204
+ end
205
+ hash
206
+ end
207
+
208
+ # Outputs non-array value in the form of hash
209
+ # For object, use to_hash. Otherwise, just return the value
210
+ # @param [Object] value Any valid value
211
+ # @return [Hash] Returns the value in the form of hash
212
+ def _to_hash(value)
213
+ if value.is_a?(Array)
214
+ value.compact.map { |v| _to_hash(v) }
215
+ elsif value.is_a?(Hash)
216
+ {}.tap do |hash|
217
+ value.each { |k, v| hash[k] = _to_hash(v) }
218
+ end
219
+ elsif value.respond_to? :to_hash
220
+ value.to_hash
221
+ else
222
+ value
223
+ end
224
+ end
225
+
226
+ end
227
+
228
+ end
@@ -23,13 +23,16 @@ module UltracartClient
23
23
 
24
24
  attr_accessor :pages
25
25
 
26
+ attr_accessor :parameters
27
+
26
28
  # Attribute mapping from ruby-style variable name to JSON key.
27
29
  def self.attribute_map
28
30
  {
29
31
  :'data_warehouse_custom_dashboard_oid' => :'data_warehouse_custom_dashboard_oid',
30
32
  :'merchant_id' => :'merchant_id',
31
33
  :'name' => :'name',
32
- :'pages' => :'pages'
34
+ :'pages' => :'pages',
35
+ :'parameters' => :'parameters'
33
36
  }
34
37
  end
35
38
 
@@ -44,7 +47,8 @@ module UltracartClient
44
47
  :'data_warehouse_custom_dashboard_oid' => :'Integer',
45
48
  :'merchant_id' => :'String',
46
49
  :'name' => :'String',
47
- :'pages' => :'Array<CustomDashboardPage>'
50
+ :'pages' => :'Array<CustomDashboardPage>',
51
+ :'parameters' => :'Array<CustomDashboardExecutionParameter>'
48
52
  }
49
53
  end
50
54
 
@@ -86,6 +90,12 @@ module UltracartClient
86
90
  self.pages = value
87
91
  end
88
92
  end
93
+
94
+ if attributes.key?(:'parameters')
95
+ if (value = attributes[:'parameters']).is_a?(Array)
96
+ self.parameters = value
97
+ end
98
+ end
89
99
  end
90
100
 
91
101
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,7 +119,8 @@ module UltracartClient
109
119
  data_warehouse_custom_dashboard_oid == o.data_warehouse_custom_dashboard_oid &&
110
120
  merchant_id == o.merchant_id &&
111
121
  name == o.name &&
112
- pages == o.pages
122
+ pages == o.pages &&
123
+ parameters == o.parameters
113
124
  end
114
125
 
115
126
  # @see the `==` method
@@ -121,7 +132,7 @@ module UltracartClient
121
132
  # Calculates hash code according to all attributes.
122
133
  # @return [Integer] Hash code
123
134
  def hash
124
- [data_warehouse_custom_dashboard_oid, merchant_id, name, pages].hash
135
+ [data_warehouse_custom_dashboard_oid, merchant_id, name, pages, parameters].hash
125
136
  end
126
137
 
127
138
  # Builds the object from hash
@@ -0,0 +1,246 @@
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 CustomDashboardExecutionParameter
18
+ attr_accessor :name
19
+
20
+ attr_accessor :quick_pick_key
21
+
22
+ attr_accessor :type
23
+
24
+ attr_accessor :value
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'name' => :'name',
30
+ :'quick_pick_key' => :'quick_pick_key',
31
+ :'type' => :'type',
32
+ :'value' => :'value'
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
+ :'name' => :'String',
45
+ :'quick_pick_key' => :'String',
46
+ :'type' => :'String',
47
+ :'value' => :'String'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CustomDashboardExecutionParameter` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ attributes = attributes.each_with_object({}) { |(k, v), h|
66
+ if (!self.class.attribute_map.key?(k.to_sym))
67
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CustomDashboardExecutionParameter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
68
+ end
69
+ h[k.to_sym] = v
70
+ }
71
+
72
+ if attributes.key?(:'name')
73
+ self.name = attributes[:'name']
74
+ end
75
+
76
+ if attributes.key?(:'quick_pick_key')
77
+ self.quick_pick_key = attributes[:'quick_pick_key']
78
+ end
79
+
80
+ if attributes.key?(:'type')
81
+ self.type = attributes[:'type']
82
+ end
83
+
84
+ if attributes.key?(:'value')
85
+ self.value = attributes[:'value']
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ invalid_properties = Array.new
93
+ invalid_properties
94
+ end
95
+
96
+ # Check to see if the all the properties in the model are valid
97
+ # @return true if the model is valid
98
+ def valid?
99
+ true
100
+ end
101
+
102
+ # Checks equality by comparing each attribute.
103
+ # @param [Object] Object to be compared
104
+ def ==(o)
105
+ return true if self.equal?(o)
106
+ self.class == o.class &&
107
+ name == o.name &&
108
+ quick_pick_key == o.quick_pick_key &&
109
+ type == o.type &&
110
+ value == o.value
111
+ end
112
+
113
+ # @see the `==` method
114
+ # @param [Object] Object to be compared
115
+ def eql?(o)
116
+ self == o
117
+ end
118
+
119
+ # Calculates hash code according to all attributes.
120
+ # @return [Integer] Hash code
121
+ def hash
122
+ [name, quick_pick_key, type, value].hash
123
+ end
124
+
125
+ # Builds the object from hash
126
+ # @param [Hash] attributes Model attributes in the form of hash
127
+ # @return [Object] Returns the model itself
128
+ def self.build_from_hash(attributes)
129
+ new.build_from_hash(attributes)
130
+ end
131
+
132
+ # Builds the object from hash
133
+ # @param [Hash] attributes Model attributes in the form of hash
134
+ # @return [Object] Returns the model itself
135
+ def build_from_hash(attributes)
136
+ return nil unless attributes.is_a?(Hash)
137
+ attributes = attributes.transform_keys(&:to_sym)
138
+ self.class.openapi_types.each_pair do |key, type|
139
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
140
+ self.send("#{key}=", nil)
141
+ elsif type =~ /\AArray<(.*)>/i
142
+ # check to ensure the input is an array given that the attribute
143
+ # is documented as an array but the input is not
144
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
145
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
146
+ end
147
+ elsif !attributes[self.class.attribute_map[key]].nil?
148
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
149
+ end
150
+ end
151
+
152
+ self
153
+ end
154
+
155
+ # Deserializes the data based on type
156
+ # @param string type Data type
157
+ # @param string value Value to be deserialized
158
+ # @return [Object] Deserialized data
159
+ def _deserialize(type, value)
160
+ case type.to_sym
161
+ when :Time
162
+ Time.parse(value)
163
+ when :Date
164
+ Date.parse(value)
165
+ when :String
166
+ value.to_s
167
+ when :Integer
168
+ value.to_i
169
+ when :Float
170
+ value.to_f
171
+ when :Boolean
172
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
173
+ true
174
+ else
175
+ false
176
+ end
177
+ when :Object
178
+ # generic object (usually a Hash), return directly
179
+ value
180
+ when /\AArray<(?<inner_type>.+)>\z/
181
+ inner_type = Regexp.last_match[:inner_type]
182
+ value.map { |v| _deserialize(inner_type, v) }
183
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
184
+ k_type = Regexp.last_match[:k_type]
185
+ v_type = Regexp.last_match[:v_type]
186
+ {}.tap do |hash|
187
+ value.each do |k, v|
188
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
189
+ end
190
+ end
191
+ else # model
192
+ # models (e.g. Pet) or oneOf
193
+ klass = UltracartClient.const_get(type)
194
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
195
+ end
196
+ end
197
+
198
+ # Returns the string representation of the object
199
+ # @return [String] String presentation of the object
200
+ def to_s
201
+ to_hash.to_s
202
+ end
203
+
204
+ # to_body is an alias to to_hash (backward compatibility)
205
+ # @return [Hash] Returns the object in the form of hash
206
+ def to_body
207
+ to_hash
208
+ end
209
+
210
+ # Returns the object in the form of hash
211
+ # @return [Hash] Returns the object in the form of hash
212
+ def to_hash
213
+ hash = {}
214
+ self.class.attribute_map.each_pair do |attr, param|
215
+ value = self.send(attr)
216
+ if value.nil?
217
+ is_nullable = self.class.openapi_nullable.include?(attr)
218
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
219
+ end
220
+
221
+ hash[param] = _to_hash(value)
222
+ end
223
+ hash
224
+ end
225
+
226
+ # Outputs non-array value in the form of hash
227
+ # For object, use to_hash. Otherwise, just return the value
228
+ # @param [Object] value Any valid value
229
+ # @return [Hash] Returns the value in the form of hash
230
+ def _to_hash(value)
231
+ if value.is_a?(Array)
232
+ value.compact.map { |v| _to_hash(v) }
233
+ elsif value.is_a?(Hash)
234
+ {}.tap do |hash|
235
+ value.each { |k, v| hash[k] = _to_hash(v) }
236
+ end
237
+ elsif value.respond_to? :to_hash
238
+ value.to_hash
239
+ else
240
+ value
241
+ end
242
+ end
243
+
244
+ end
245
+
246
+ end
@@ -17,6 +17,8 @@ module UltracartClient
17
17
  class CustomReportExecutionParameter
18
18
  attr_accessor :name
19
19
 
20
+ attr_accessor :quick_pick_key
21
+
20
22
  attr_accessor :type
21
23
 
22
24
  attr_accessor :value
@@ -25,6 +27,7 @@ module UltracartClient
25
27
  def self.attribute_map
26
28
  {
27
29
  :'name' => :'name',
30
+ :'quick_pick_key' => :'quick_pick_key',
28
31
  :'type' => :'type',
29
32
  :'value' => :'value'
30
33
  }
@@ -39,6 +42,7 @@ module UltracartClient
39
42
  def self.openapi_types
40
43
  {
41
44
  :'name' => :'String',
45
+ :'quick_pick_key' => :'String',
42
46
  :'type' => :'String',
43
47
  :'value' => :'String'
44
48
  }
@@ -69,6 +73,10 @@ module UltracartClient
69
73
  self.name = attributes[:'name']
70
74
  end
71
75
 
76
+ if attributes.key?(:'quick_pick_key')
77
+ self.quick_pick_key = attributes[:'quick_pick_key']
78
+ end
79
+
72
80
  if attributes.key?(:'type')
73
81
  self.type = attributes[:'type']
74
82
  end
@@ -97,6 +105,7 @@ module UltracartClient
97
105
  return true if self.equal?(o)
98
106
  self.class == o.class &&
99
107
  name == o.name &&
108
+ quick_pick_key == o.quick_pick_key &&
100
109
  type == o.type &&
101
110
  value == o.value
102
111
  end
@@ -110,7 +119,7 @@ module UltracartClient
110
119
  # Calculates hash code according to all attributes.
111
120
  # @return [Integer] Hash code
112
121
  def hash
113
- [name, type, value].hash
122
+ [name, quick_pick_key, type, value].hash
114
123
  end
115
124
 
116
125
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.18'
14
+ VERSION = '4.1.19'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -241,6 +241,7 @@ require 'ultracart_api/models/conversation_virtual_agent_budget'
241
241
  require 'ultracart_api/models/conversation_virtual_agent_budget_response'
242
242
  require 'ultracart_api/models/conversation_virtual_agent_capabilities'
243
243
  require 'ultracart_api/models/conversation_virtual_agent_capabilities_response'
244
+ require 'ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department'
244
245
  require 'ultracart_api/models/conversation_webchat_context'
245
246
  require 'ultracart_api/models/conversation_webchat_queue_status'
246
247
  require 'ultracart_api/models/conversation_webchat_queue_status_agent'
@@ -322,6 +323,7 @@ require 'ultracart_api/models/coupons_request'
322
323
  require 'ultracart_api/models/coupons_response'
323
324
  require 'ultracart_api/models/currency'
324
325
  require 'ultracart_api/models/custom_dashboard'
326
+ require 'ultracart_api/models/custom_dashboard_execution_parameter'
325
327
  require 'ultracart_api/models/custom_dashboard_page'
326
328
  require 'ultracart_api/models/custom_dashboard_page_report'
327
329
  require 'ultracart_api/models/custom_dashboard_response'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.18
4
+ version: 4.1.19
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
@@ -291,6 +291,7 @@ files:
291
291
  - docs/ConversationVirtualAgentBudgetResponse.md
292
292
  - docs/ConversationVirtualAgentCapabilities.md
293
293
  - docs/ConversationVirtualAgentCapabilitiesResponse.md
294
+ - docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md
294
295
  - docs/ConversationWebchatContext.md
295
296
  - docs/ConversationWebchatQueueStatus.md
296
297
  - docs/ConversationWebchatQueueStatusAgent.md
@@ -373,6 +374,7 @@ files:
373
374
  - docs/CouponsResponse.md
374
375
  - docs/Currency.md
375
376
  - docs/CustomDashboard.md
377
+ - docs/CustomDashboardExecutionParameter.md
376
378
  - docs/CustomDashboardPage.md
377
379
  - docs/CustomDashboardPageReport.md
378
380
  - docs/CustomDashboardResponse.md
@@ -1216,6 +1218,7 @@ files:
1216
1218
  - lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb
1217
1219
  - lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb
1218
1220
  - lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb
1221
+ - lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb
1219
1222
  - lib/ultracart_api/models/conversation_webchat_context.rb
1220
1223
  - lib/ultracart_api/models/conversation_webchat_queue_status.rb
1221
1224
  - lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb
@@ -1297,6 +1300,7 @@ files:
1297
1300
  - lib/ultracart_api/models/coupons_response.rb
1298
1301
  - lib/ultracart_api/models/currency.rb
1299
1302
  - lib/ultracart_api/models/custom_dashboard.rb
1303
+ - lib/ultracart_api/models/custom_dashboard_execution_parameter.rb
1300
1304
  - lib/ultracart_api/models/custom_dashboard_page.rb
1301
1305
  - lib/ultracart_api/models/custom_dashboard_page_report.rb
1302
1306
  - lib/ultracart_api/models/custom_dashboard_response.rb