ultracart_api 4.1.132 → 4.1.134
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 +4 -2
- data/docs/ConversationPbxAgent.md +5 -1
- data/docs/ConversationPbxMenuMapping.md +3 -1
- data/docs/Order.md +1 -1
- data/docs/OrderPayment.md +1 -1
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +39 -4
- data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +31 -6
- data/lib/ultracart_api/models/order.rb +1 -1
- data/lib/ultracart_api/models/order_payment.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 20bcac4c6967bcfbd765b99773274f76dcd2b40bfbedd27054e1e681b48d8f70
|
|
4
|
+
data.tar.gz: d00b9dde925dff6008193d54a7eb2d189c25b426f737e98cc822c11ef1f175ff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f003388ae928510c5cebace59e1d27405526c00d6c6ff22201c9a47609a55d936a3e38cd7def497705e8ac989714889c55bde00b6a2901e90b3361e8c9af274c
|
|
7
|
+
data.tar.gz: ccdf6f09bed30972805d463ab74eca01a85b314bf1e6482d41062f9bcf8b1b0278479f430d3c9912a667264ac90dac54c7f966e4812feb5c8d538e1777a70758
|
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.134
|
|
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.134'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -1836,6 +1836,8 @@ Not every change is committed to every SDK.
|
|
|
1836
1836
|
|
|
1837
1837
|
| Version | Date | Comments |
|
|
1838
1838
|
| --: | :-: | --- |
|
|
1839
|
+
| 4.1.134 | 08/21/2026 | conversation - pbx menu mapping for send text |
|
|
1840
|
+
| 4.1.133 | 08/20/2026 | conversations - pbx agent setting for creating tickets in zoho desk for outgoing calls |
|
|
1839
1841
|
| 4.1.132 | 08/18/2026 | customer activity bug fix |
|
|
1840
1842
|
| 4.1.131 | 08/18/2026 | customer activity now returns the SF communications active flag and last_activity_dts |
|
|
1841
1843
|
| 4.1.130 | 08/17/2026 | order api - new method to obtain customer activity similar to the customer endpoint for a profile |
|
|
@@ -25,6 +25,8 @@
|
|
|
25
25
|
| **unavailable_say_voice** | **String** | Unavailable say voice | [optional] |
|
|
26
26
|
| **user_id** | **Integer** | User Id | [optional] |
|
|
27
27
|
| **voicemail** | **Boolean** | True if this agent has voicemail configured | [optional] |
|
|
28
|
+
| **zoho_desk_outbound_department_id** | **String** | Zoho Desk department ID to create outbound-call tickets in for this agent | [optional] |
|
|
29
|
+
| **zoho_desk_outbound_ticket_enabled** | **Boolean** | If true, a Zoho Desk ticket is automatically created for outbound calls placed by this agent | [optional] |
|
|
28
30
|
|
|
29
31
|
## Example
|
|
30
32
|
|
|
@@ -52,7 +54,9 @@ instance = UltracartClient::ConversationPbxAgent.new(
|
|
|
52
54
|
unavailable_say: null,
|
|
53
55
|
unavailable_say_voice: null,
|
|
54
56
|
user_id: null,
|
|
55
|
-
voicemail: null
|
|
57
|
+
voicemail: null,
|
|
58
|
+
zoho_desk_outbound_department_id: null,
|
|
59
|
+
zoho_desk_outbound_ticket_enabled: null
|
|
56
60
|
)
|
|
57
61
|
```
|
|
58
62
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **action_target** | **String** | Action target. This is the UUID associated with the configuration object of that particular type. | [optional] |
|
|
9
9
|
| **digits** | **Integer** | Digits | [optional] |
|
|
10
10
|
| **speech** | **String** | Speech | [optional] |
|
|
11
|
+
| **text_message** | **String** | Text message body sent to the caller when the action is 'send text'. Ignored for all other actions. | [optional] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,7 +19,8 @@ instance = UltracartClient::ConversationPbxMenuMapping.new(
|
|
|
18
19
|
action: null,
|
|
19
20
|
action_target: null,
|
|
20
21
|
digits: null,
|
|
21
|
-
speech: null
|
|
22
|
+
speech: null,
|
|
23
|
+
text_message: null
|
|
22
24
|
)
|
|
23
25
|
```
|
|
24
26
|
|
data/docs/Order.md
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
| **order_id** | **String** | Order ID | [optional] |
|
|
33
33
|
| **payment** | [**OrderPayment**](OrderPayment.md) | | [optional] |
|
|
34
34
|
| **point_of_sale** | [**OrderPointOfSale**](OrderPointOfSale.md) | | [optional] |
|
|
35
|
-
| **properties** | [**Array<OrderProperty>**](OrderProperty.md) | Properties
|
|
35
|
+
| **properties** | [**Array<OrderProperty>**](OrderProperty.md) | Properties associated with the order | [optional] |
|
|
36
36
|
| **quote** | [**OrderQuote**](OrderQuote.md) | | [optional] |
|
|
37
37
|
| **refund_dts** | **String** | If the order was refunded, the date/time that the last refund occurred | [optional] |
|
|
38
38
|
| **refund_reason** | **String** | Refund reason code. This can only be written during a refund operation otherwise this field is read only. | [optional] |
|
data/docs/OrderPayment.md
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
| **surcharge_transaction_fee** | **Float** | Surcharge transaction fee | [optional] |
|
|
24
24
|
| **surcharge_transaction_percentage** | **Float** | Surcharge transaction percentage | [optional] |
|
|
25
25
|
| **test_order** | **Boolean** | True if this is a test order | [optional] |
|
|
26
|
-
| **transactions** | [**Array<OrderPaymentTransaction>**](OrderPaymentTransaction.md) | Transactions associated with processing this payment | [optional] |
|
|
26
|
+
| **transactions** | [**Array<OrderPaymentTransaction>**](OrderPaymentTransaction.md) | Transactions associated with processing this payment. Accepted on insert to carry the payment history of an order captured outside the system. | [optional] |
|
|
27
27
|
|
|
28
28
|
## Example
|
|
29
29
|
|
|
@@ -78,6 +78,12 @@ module UltracartClient
|
|
|
78
78
|
# True if this agent has voicemail configured
|
|
79
79
|
attr_accessor :voicemail
|
|
80
80
|
|
|
81
|
+
# Zoho Desk department ID to create outbound-call tickets in for this agent
|
|
82
|
+
attr_accessor :zoho_desk_outbound_department_id
|
|
83
|
+
|
|
84
|
+
# If true, a Zoho Desk ticket is automatically created for outbound calls placed by this agent
|
|
85
|
+
attr_accessor :zoho_desk_outbound_ticket_enabled
|
|
86
|
+
|
|
81
87
|
class EnumAttributeValidator
|
|
82
88
|
attr_reader :datatype
|
|
83
89
|
attr_reader :allowable_values
|
|
@@ -123,7 +129,9 @@ module UltracartClient
|
|
|
123
129
|
:'unavailable_say' => :'unavailable_say',
|
|
124
130
|
:'unavailable_say_voice' => :'unavailable_say_voice',
|
|
125
131
|
:'user_id' => :'user_id',
|
|
126
|
-
:'voicemail' => :'voicemail'
|
|
132
|
+
:'voicemail' => :'voicemail',
|
|
133
|
+
:'zoho_desk_outbound_department_id' => :'zoho_desk_outbound_department_id',
|
|
134
|
+
:'zoho_desk_outbound_ticket_enabled' => :'zoho_desk_outbound_ticket_enabled'
|
|
127
135
|
}
|
|
128
136
|
end
|
|
129
137
|
|
|
@@ -155,7 +163,9 @@ module UltracartClient
|
|
|
155
163
|
:'unavailable_say' => :'String',
|
|
156
164
|
:'unavailable_say_voice' => :'String',
|
|
157
165
|
:'user_id' => :'Integer',
|
|
158
|
-
:'voicemail' => :'Boolean'
|
|
166
|
+
:'voicemail' => :'Boolean',
|
|
167
|
+
:'zoho_desk_outbound_department_id' => :'String',
|
|
168
|
+
:'zoho_desk_outbound_ticket_enabled' => :'Boolean'
|
|
159
169
|
}
|
|
160
170
|
end
|
|
161
171
|
|
|
@@ -265,6 +275,14 @@ module UltracartClient
|
|
|
265
275
|
if attributes.key?(:'voicemail')
|
|
266
276
|
self.voicemail = attributes[:'voicemail']
|
|
267
277
|
end
|
|
278
|
+
|
|
279
|
+
if attributes.key?(:'zoho_desk_outbound_department_id')
|
|
280
|
+
self.zoho_desk_outbound_department_id = attributes[:'zoho_desk_outbound_department_id']
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
if attributes.key?(:'zoho_desk_outbound_ticket_enabled')
|
|
284
|
+
self.zoho_desk_outbound_ticket_enabled = attributes[:'zoho_desk_outbound_ticket_enabled']
|
|
285
|
+
end
|
|
268
286
|
end
|
|
269
287
|
|
|
270
288
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -299,6 +317,10 @@ module UltracartClient
|
|
|
299
317
|
invalid_properties.push('invalid value for "unavailable_say_voice", the character length must be smaller than or equal to 50.')
|
|
300
318
|
end
|
|
301
319
|
|
|
320
|
+
if !@zoho_desk_outbound_department_id.nil? && @zoho_desk_outbound_department_id.to_s.length > 50
|
|
321
|
+
invalid_properties.push('invalid value for "zoho_desk_outbound_department_id", the character length must be smaller than or equal to 50.')
|
|
322
|
+
end
|
|
323
|
+
|
|
302
324
|
invalid_properties
|
|
303
325
|
end
|
|
304
326
|
|
|
@@ -316,6 +338,7 @@ module UltracartClient
|
|
|
316
338
|
unavailable_say_voice_validator = EnumAttributeValidator.new('String', ["man", "woman"])
|
|
317
339
|
return false unless unavailable_say_voice_validator.valid?(@unavailable_say_voice)
|
|
318
340
|
return false if !@unavailable_say_voice.nil? && @unavailable_say_voice.to_s.length > 50
|
|
341
|
+
return false if !@zoho_desk_outbound_department_id.nil? && @zoho_desk_outbound_department_id.to_s.length > 50
|
|
319
342
|
true
|
|
320
343
|
end
|
|
321
344
|
|
|
@@ -399,6 +422,16 @@ module UltracartClient
|
|
|
399
422
|
@unavailable_say_voice = unavailable_say_voice
|
|
400
423
|
end
|
|
401
424
|
|
|
425
|
+
# Custom attribute writer method with validation
|
|
426
|
+
# @param [Object] zoho_desk_outbound_department_id Value to be assigned
|
|
427
|
+
def zoho_desk_outbound_department_id=(zoho_desk_outbound_department_id)
|
|
428
|
+
if !zoho_desk_outbound_department_id.nil? && zoho_desk_outbound_department_id.to_s.length > 50
|
|
429
|
+
fail ArgumentError, 'invalid value for "zoho_desk_outbound_department_id", the character length must be smaller than or equal to 50.'
|
|
430
|
+
end
|
|
431
|
+
|
|
432
|
+
@zoho_desk_outbound_department_id = zoho_desk_outbound_department_id
|
|
433
|
+
end
|
|
434
|
+
|
|
402
435
|
# Checks equality by comparing each attribute.
|
|
403
436
|
# @param [Object] Object to be compared
|
|
404
437
|
def ==(o)
|
|
@@ -424,7 +457,9 @@ module UltracartClient
|
|
|
424
457
|
unavailable_say == o.unavailable_say &&
|
|
425
458
|
unavailable_say_voice == o.unavailable_say_voice &&
|
|
426
459
|
user_id == o.user_id &&
|
|
427
|
-
voicemail == o.voicemail
|
|
460
|
+
voicemail == o.voicemail &&
|
|
461
|
+
zoho_desk_outbound_department_id == o.zoho_desk_outbound_department_id &&
|
|
462
|
+
zoho_desk_outbound_ticket_enabled == o.zoho_desk_outbound_ticket_enabled
|
|
428
463
|
end
|
|
429
464
|
|
|
430
465
|
# @see the `==` method
|
|
@@ -436,7 +471,7 @@ module UltracartClient
|
|
|
436
471
|
# Calculates hash code according to all attributes.
|
|
437
472
|
# @return [Integer] Hash code
|
|
438
473
|
def hash
|
|
439
|
-
[ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail].hash
|
|
474
|
+
[ai, call_routing_preference, cellphone, conversation_pbx_agent_uuid, cos_uuid, default_phone_number_uuid, extension, full_name, hardware_phone_uuids, login, merchant_id, personal_conversation_pbx_voicemail_mailbox_uuid, preferred_hardware_phone_uuid, record_outgoing_automatically, shared_conversation_pbx_voicemail_mailbox_uuid, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail, zoho_desk_outbound_department_id, zoho_desk_outbound_ticket_enabled].hash
|
|
440
475
|
end
|
|
441
476
|
|
|
442
477
|
# Builds the object from hash
|
|
@@ -27,6 +27,9 @@ module UltracartClient
|
|
|
27
27
|
# Speech
|
|
28
28
|
attr_accessor :speech
|
|
29
29
|
|
|
30
|
+
# Text message body sent to the caller when the action is 'send text'. Ignored for all other actions.
|
|
31
|
+
attr_accessor :text_message
|
|
32
|
+
|
|
30
33
|
class EnumAttributeValidator
|
|
31
34
|
attr_reader :datatype
|
|
32
35
|
attr_reader :allowable_values
|
|
@@ -55,7 +58,8 @@ module UltracartClient
|
|
|
55
58
|
:'action' => :'action',
|
|
56
59
|
:'action_target' => :'action_target',
|
|
57
60
|
:'digits' => :'digits',
|
|
58
|
-
:'speech' => :'speech'
|
|
61
|
+
:'speech' => :'speech',
|
|
62
|
+
:'text_message' => :'text_message'
|
|
59
63
|
}
|
|
60
64
|
end
|
|
61
65
|
|
|
@@ -70,7 +74,8 @@ module UltracartClient
|
|
|
70
74
|
:'action' => :'String',
|
|
71
75
|
:'action_target' => :'String',
|
|
72
76
|
:'digits' => :'Integer',
|
|
73
|
-
:'speech' => :'String'
|
|
77
|
+
:'speech' => :'String',
|
|
78
|
+
:'text_message' => :'String'
|
|
74
79
|
}
|
|
75
80
|
end
|
|
76
81
|
|
|
@@ -110,6 +115,10 @@ module UltracartClient
|
|
|
110
115
|
if attributes.key?(:'speech')
|
|
111
116
|
self.speech = attributes[:'speech']
|
|
112
117
|
end
|
|
118
|
+
|
|
119
|
+
if attributes.key?(:'text_message')
|
|
120
|
+
self.text_message = attributes[:'text_message']
|
|
121
|
+
end
|
|
113
122
|
end
|
|
114
123
|
|
|
115
124
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -124,23 +133,28 @@ module UltracartClient
|
|
|
124
133
|
invalid_properties.push('invalid value for "action_target", the character length must be smaller than or equal to 50.')
|
|
125
134
|
end
|
|
126
135
|
|
|
136
|
+
if !@text_message.nil? && @text_message.to_s.length > 1600
|
|
137
|
+
invalid_properties.push('invalid value for "text_message", the character length must be smaller than or equal to 1600.')
|
|
138
|
+
end
|
|
139
|
+
|
|
127
140
|
invalid_properties
|
|
128
141
|
end
|
|
129
142
|
|
|
130
143
|
# Check to see if the all the properties in the model are valid
|
|
131
144
|
# @return true if the model is valid
|
|
132
145
|
def valid?
|
|
133
|
-
action_validator = EnumAttributeValidator.new('String', ["time based", "menu", "queue", "voicemail", "agent"])
|
|
146
|
+
action_validator = EnumAttributeValidator.new('String', ["time based", "menu", "queue", "voicemail", "agent", "send text"])
|
|
134
147
|
return false unless action_validator.valid?(@action)
|
|
135
148
|
return false if !@action.nil? && @action.to_s.length > 30
|
|
136
149
|
return false if !@action_target.nil? && @action_target.to_s.length > 50
|
|
150
|
+
return false if !@text_message.nil? && @text_message.to_s.length > 1600
|
|
137
151
|
true
|
|
138
152
|
end
|
|
139
153
|
|
|
140
154
|
# Custom attribute writer method checking allowed values (enum).
|
|
141
155
|
# @param [Object] action Object to be assigned
|
|
142
156
|
def action=(action)
|
|
143
|
-
validator = EnumAttributeValidator.new('String', ["time based", "menu", "queue", "voicemail", "agent"])
|
|
157
|
+
validator = EnumAttributeValidator.new('String', ["time based", "menu", "queue", "voicemail", "agent", "send text"])
|
|
144
158
|
unless validator.valid?(action)
|
|
145
159
|
fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
|
|
146
160
|
end
|
|
@@ -157,6 +171,16 @@ module UltracartClient
|
|
|
157
171
|
@action_target = action_target
|
|
158
172
|
end
|
|
159
173
|
|
|
174
|
+
# Custom attribute writer method with validation
|
|
175
|
+
# @param [Object] text_message Value to be assigned
|
|
176
|
+
def text_message=(text_message)
|
|
177
|
+
if !text_message.nil? && text_message.to_s.length > 1600
|
|
178
|
+
fail ArgumentError, 'invalid value for "text_message", the character length must be smaller than or equal to 1600.'
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
@text_message = text_message
|
|
182
|
+
end
|
|
183
|
+
|
|
160
184
|
# Checks equality by comparing each attribute.
|
|
161
185
|
# @param [Object] Object to be compared
|
|
162
186
|
def ==(o)
|
|
@@ -165,7 +189,8 @@ module UltracartClient
|
|
|
165
189
|
action == o.action &&
|
|
166
190
|
action_target == o.action_target &&
|
|
167
191
|
digits == o.digits &&
|
|
168
|
-
speech == o.speech
|
|
192
|
+
speech == o.speech &&
|
|
193
|
+
text_message == o.text_message
|
|
169
194
|
end
|
|
170
195
|
|
|
171
196
|
# @see the `==` method
|
|
@@ -177,7 +202,7 @@ module UltracartClient
|
|
|
177
202
|
# Calculates hash code according to all attributes.
|
|
178
203
|
# @return [Integer] Hash code
|
|
179
204
|
def hash
|
|
180
|
-
[action, action_target, digits, speech].hash
|
|
205
|
+
[action, action_target, digits, speech, text_message].hash
|
|
181
206
|
end
|
|
182
207
|
|
|
183
208
|
# Builds the object from hash
|
|
@@ -83,7 +83,7 @@ module UltracartClient
|
|
|
83
83
|
|
|
84
84
|
attr_accessor :point_of_sale
|
|
85
85
|
|
|
86
|
-
# Properties
|
|
86
|
+
# Properties associated with the order
|
|
87
87
|
attr_accessor :properties
|
|
88
88
|
|
|
89
89
|
attr_accessor :quote
|
|
@@ -64,7 +64,7 @@ module UltracartClient
|
|
|
64
64
|
# True if this is a test order
|
|
65
65
|
attr_accessor :test_order
|
|
66
66
|
|
|
67
|
-
# Transactions associated with processing this payment
|
|
67
|
+
# Transactions associated with processing this payment. Accepted on insert to carry the payment history of an order captured outside the system.
|
|
68
68
|
attr_accessor :transactions
|
|
69
69
|
|
|
70
70
|
class EnumAttributeValidator
|
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.134
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|