ultracart_api 4.1.131 → 4.1.133

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: e5a4475f1f429fa59ab82bad2cc5b9494c0ca2209d86c88cc16b65b0aa84761a
4
- data.tar.gz: 0db853038c0157cef18831c1ed9011c1fcd42922c8dc9ce8eaf78f183251b8ed
3
+ metadata.gz: 5d4e12b3bde634d56de93233b37caaeb4d37b31d2f39c165abfe7b908ed00f89
4
+ data.tar.gz: ddec6d4eafaba5840151781d7ec2e70b03007925f2594d40ee5222ec3d68229e
5
5
  SHA512:
6
- metadata.gz: 6f57a5d5b6338c6de68a57055646830bc7d2be593cea30e3731b59d6fa4d49b1496f4c73b557d7107721e9087bce6be083e0bb57f332d19883519c0c1cb8e068
7
- data.tar.gz: ea352daac7fd88dabfe8eee54f74ee53dc3b55abb37b8e027cf8afb82e7a370cc0504a488663da9d95d9f7ea4f4d6374b019d39991fd3aa8aeb6d5cdd74e7065
6
+ metadata.gz: 1e2abbeef1f165e14205570c4af9d084c3f1bfbba3896e0e464e288375375204ac48ddda3e491978b26e0415ce245891a8222eadcac05b731adca4c451b7c9cd
7
+ data.tar.gz: 3623da19c113377e0e632b8e0ef9c7e49e4b3c1f65720474aa4de9921fc3ddc06b7d6e29431d30a94a74a934036eb768baea6f47fd1ac76ffa5b9fd0084816d4
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.131
10
+ - Package version: 4.1.133
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.131'
19
+ gem 'ultracart_api', '4.1.133'
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.133 | 08/20/2026 | conversations - pbx agent setting for creating tickets in zoho desk for outgoing calls |
1840
+ | 4.1.132 | 08/18/2026 | customer activity bug fix |
1839
1841
  | 4.1.131 | 08/18/2026 | customer activity now returns the SF communications active flag and last_activity_dts |
1840
1842
  | 4.1.130 | 08/17/2026 | order api - new method to obtain customer activity similar to the customer endpoint for a profile |
1841
1843
  | 4.1.129 | 08/13/2026 | ChannelPartnerOrder and OrderChannelPartner were missing a property |
@@ -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
 
@@ -4,9 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **active** | **Boolean** | | [optional] |
7
8
  | **activities** | [**Array<Activity>**](Activity.md) | | [optional] |
8
9
  | **global_unsubscribed** | **Boolean** | | [optional] |
9
10
  | **global_unsubscribed_dts** | **String** | | [optional] |
11
+ | **last_activity_dts** | **String** | | [optional] |
10
12
  | **memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) | | [optional] |
11
13
  | **metrics** | [**Array<Metric>**](Metric.md) | | [optional] |
12
14
  | **properties_list** | [**Array<Property>**](Property.md) | | [optional] |
@@ -21,9 +23,11 @@
21
23
  require 'ultracart_api'
22
24
 
23
25
  instance = UltracartClient::CustomerActivity.new(
26
+ active: null,
24
27
  activities: null,
25
28
  global_unsubscribed: null,
26
29
  global_unsubscribed_dts: null,
30
+ last_activity_dts: null,
27
31
  memberships: null,
28
32
  metrics: null,
29
33
  properties_list: null,
data/docs/Metric.md CHANGED
@@ -4,12 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **active** | **Boolean** | | [optional] |
8
7
  | **all_time** | **Float** | | [optional] |
9
8
  | **all_time_formatted** | **String** | | [optional] |
10
9
  | **last_30** | **Float** | | [optional] |
11
10
  | **last_30_formatted** | **String** | | [optional] |
12
- | **last_activity_dts** | **String** | | [optional] |
13
11
  | **name** | **String** | | [optional] |
14
12
  | **prior_30** | **Float** | | [optional] |
15
13
  | **prior_30_formatted** | **String** | | [optional] |
@@ -21,12 +19,10 @@
21
19
  require 'ultracart_api'
22
20
 
23
21
  instance = UltracartClient::Metric.new(
24
- active: null,
25
22
  all_time: null,
26
23
  all_time_formatted: null,
27
24
  last_30: null,
28
25
  last_30_formatted: null,
29
- last_activity_dts: null,
30
26
  name: null,
31
27
  prior_30: null,
32
28
  prior_30_formatted: null,
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, available only through update, not through insert due to the nature of how properties are handled internally | [optional] |
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
@@ -15,12 +15,16 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class CustomerActivity
18
+ attr_accessor :active
19
+
18
20
  attr_accessor :activities
19
21
 
20
22
  attr_accessor :global_unsubscribed
21
23
 
22
24
  attr_accessor :global_unsubscribed_dts
23
25
 
26
+ attr_accessor :last_activity_dts
27
+
24
28
  attr_accessor :memberships
25
29
 
26
30
  attr_accessor :metrics
@@ -38,9 +42,11 @@ module UltracartClient
38
42
  # Attribute mapping from ruby-style variable name to JSON key.
39
43
  def self.attribute_map
40
44
  {
45
+ :'active' => :'active',
41
46
  :'activities' => :'activities',
42
47
  :'global_unsubscribed' => :'global_unsubscribed',
43
48
  :'global_unsubscribed_dts' => :'global_unsubscribed_dts',
49
+ :'last_activity_dts' => :'last_activity_dts',
44
50
  :'memberships' => :'memberships',
45
51
  :'metrics' => :'metrics',
46
52
  :'properties_list' => :'properties_list',
@@ -59,9 +65,11 @@ module UltracartClient
59
65
  # Attribute type mapping.
60
66
  def self.openapi_types
61
67
  {
68
+ :'active' => :'Boolean',
62
69
  :'activities' => :'Array<Activity>',
63
70
  :'global_unsubscribed' => :'Boolean',
64
71
  :'global_unsubscribed_dts' => :'String',
72
+ :'last_activity_dts' => :'String',
65
73
  :'memberships' => :'Array<ListSegmentMembership>',
66
74
  :'metrics' => :'Array<Metric>',
67
75
  :'properties_list' => :'Array<Property>',
@@ -93,6 +101,10 @@ module UltracartClient
93
101
  h[k.to_sym] = v
94
102
  }
95
103
 
104
+ if attributes.key?(:'active')
105
+ self.active = attributes[:'active']
106
+ end
107
+
96
108
  if attributes.key?(:'activities')
97
109
  if (value = attributes[:'activities']).is_a?(Array)
98
110
  self.activities = value
@@ -107,6 +119,10 @@ module UltracartClient
107
119
  self.global_unsubscribed_dts = attributes[:'global_unsubscribed_dts']
108
120
  end
109
121
 
122
+ if attributes.key?(:'last_activity_dts')
123
+ self.last_activity_dts = attributes[:'last_activity_dts']
124
+ end
125
+
110
126
  if attributes.key?(:'memberships')
111
127
  if (value = attributes[:'memberships']).is_a?(Array)
112
128
  self.memberships = value
@@ -160,9 +176,11 @@ module UltracartClient
160
176
  def ==(o)
161
177
  return true if self.equal?(o)
162
178
  self.class == o.class &&
179
+ active == o.active &&
163
180
  activities == o.activities &&
164
181
  global_unsubscribed == o.global_unsubscribed &&
165
182
  global_unsubscribed_dts == o.global_unsubscribed_dts &&
183
+ last_activity_dts == o.last_activity_dts &&
166
184
  memberships == o.memberships &&
167
185
  metrics == o.metrics &&
168
186
  properties_list == o.properties_list &&
@@ -181,7 +199,7 @@ module UltracartClient
181
199
  # Calculates hash code according to all attributes.
182
200
  # @return [Integer] Hash code
183
201
  def hash
184
- [activities, global_unsubscribed, global_unsubscribed_dts, memberships, metrics, properties_list, sms, sms_stop, spam_complaint, spam_complaint_dts].hash
202
+ [active, activities, global_unsubscribed, global_unsubscribed_dts, last_activity_dts, memberships, metrics, properties_list, sms, sms_stop, spam_complaint, spam_complaint_dts].hash
185
203
  end
186
204
 
187
205
  # Builds the object from hash
@@ -15,8 +15,6 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class Metric
18
- attr_accessor :active
19
-
20
18
  attr_accessor :all_time
21
19
 
22
20
  attr_accessor :all_time_formatted
@@ -25,8 +23,6 @@ module UltracartClient
25
23
 
26
24
  attr_accessor :last_30_formatted
27
25
 
28
- attr_accessor :last_activity_dts
29
-
30
26
  attr_accessor :name
31
27
 
32
28
  attr_accessor :prior_30
@@ -38,12 +34,10 @@ module UltracartClient
38
34
  # Attribute mapping from ruby-style variable name to JSON key.
39
35
  def self.attribute_map
40
36
  {
41
- :'active' => :'active',
42
37
  :'all_time' => :'all_time',
43
38
  :'all_time_formatted' => :'all_time_formatted',
44
39
  :'last_30' => :'last_30',
45
40
  :'last_30_formatted' => :'last_30_formatted',
46
- :'last_activity_dts' => :'last_activity_dts',
47
41
  :'name' => :'name',
48
42
  :'prior_30' => :'prior_30',
49
43
  :'prior_30_formatted' => :'prior_30_formatted',
@@ -59,12 +53,10 @@ module UltracartClient
59
53
  # Attribute type mapping.
60
54
  def self.openapi_types
61
55
  {
62
- :'active' => :'Boolean',
63
56
  :'all_time' => :'Float',
64
57
  :'all_time_formatted' => :'String',
65
58
  :'last_30' => :'Float',
66
59
  :'last_30_formatted' => :'String',
67
- :'last_activity_dts' => :'String',
68
60
  :'name' => :'String',
69
61
  :'prior_30' => :'Float',
70
62
  :'prior_30_formatted' => :'String',
@@ -93,10 +85,6 @@ module UltracartClient
93
85
  h[k.to_sym] = v
94
86
  }
95
87
 
96
- if attributes.key?(:'active')
97
- self.active = attributes[:'active']
98
- end
99
-
100
88
  if attributes.key?(:'all_time')
101
89
  self.all_time = attributes[:'all_time']
102
90
  end
@@ -113,10 +101,6 @@ module UltracartClient
113
101
  self.last_30_formatted = attributes[:'last_30_formatted']
114
102
  end
115
103
 
116
- if attributes.key?(:'last_activity_dts')
117
- self.last_activity_dts = attributes[:'last_activity_dts']
118
- end
119
-
120
104
  if attributes.key?(:'name')
121
105
  self.name = attributes[:'name']
122
106
  end
@@ -152,12 +136,10 @@ module UltracartClient
152
136
  def ==(o)
153
137
  return true if self.equal?(o)
154
138
  self.class == o.class &&
155
- active == o.active &&
156
139
  all_time == o.all_time &&
157
140
  all_time_formatted == o.all_time_formatted &&
158
141
  last_30 == o.last_30 &&
159
142
  last_30_formatted == o.last_30_formatted &&
160
- last_activity_dts == o.last_activity_dts &&
161
143
  name == o.name &&
162
144
  prior_30 == o.prior_30 &&
163
145
  prior_30_formatted == o.prior_30_formatted &&
@@ -173,7 +155,7 @@ module UltracartClient
173
155
  # Calculates hash code according to all attributes.
174
156
  # @return [Integer] Hash code
175
157
  def hash
176
- [active, all_time, all_time_formatted, last_30, last_30_formatted, last_activity_dts, name, prior_30, prior_30_formatted, type].hash
158
+ [all_time, all_time_formatted, last_30, last_30_formatted, name, prior_30, prior_30_formatted, type].hash
177
159
  end
178
160
 
179
161
  # Builds the object from hash
@@ -83,7 +83,7 @@ module UltracartClient
83
83
 
84
84
  attr_accessor :point_of_sale
85
85
 
86
- # Properties, available only through update, not through insert due to the nature of how properties are handled internally
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
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.131'
14
+ VERSION = '4.1.133'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.131
4
+ version: 4.1.133
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-18 00:00:00.000000000 Z
11
+ date: 2026-08-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus