ultracart_api 4.1.129 → 4.1.130

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: 5f7c65d97b1349cd7b399cad65f0395b7b56fbc11b508536715434c217506345
4
- data.tar.gz: '048918a9f54b72137453c84e434bb462e157f296c26ec6d001b97f15a0dd0a73'
3
+ metadata.gz: 80beaeb3b122e1068265b18e911e2cb88c50f7bd2f2740b5ba831d27f857e6f0
4
+ data.tar.gz: 2bc36c0875ddddf8474c1e14430db86342d62a3d10a9bc289ee377a58b612c39
5
5
  SHA512:
6
- metadata.gz: 5aabcca47cfd19505898210d42004c5bb9a26cab1a23c2908c01b9d4a7186b4e65358f4ba54b83ef04102e6c663fe2cb5b2030e1b384a1b331e701aefe394cba
7
- data.tar.gz: 6a8bf46ae4dca1e03ab734fd8aa5b66e654204fca56b8ec7262fc20511df593d21b1147afc79da15496d198ed2de23637407e6470272dd991c1a900145cb4db1
6
+ metadata.gz: c8d003f12a9e4be88688c83477d3eebad2702321c92dd94f4b0ddbf223db88d10aba76415218daa55d7c2dc1df472f5e27ef9d703bba4f26df21e5bf9966b441
7
+ data.tar.gz: 51f9de580d49f15273791ebb094fae28f883d54f39bcc3bd05f6977dfc5292bd54715c391da8847e050d445d328cabab2f9607c19307545cca767e3e60807102
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.129
10
+ - Package version: 4.1.130
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.129'
19
+ gem 'ultracart_api', '4.1.130'
20
20
  ```
21
21
 
22
22
  install:
@@ -445,6 +445,7 @@ Class | Method | HTTP request | Description
445
445
  *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
446
446
  *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
447
447
  *UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
448
+ *UltracartClient::OrderApi* | [**get_order_customer_activity**](docs/OrderApi.md#get_order_customer_activity) | **GET** /order/orders/{order_id}/customer_activity | Retrieve customer activity for this order.
448
449
  *UltracartClient::OrderApi* | [**get_order_edi_documents**](docs/OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
449
450
  *UltracartClient::OrderApi* | [**get_order_emails**](docs/OrderApi.md#get_order_emails) | **GET** /order/orders/{order_id}/emails | Retrieve email delivery information for this order.
450
451
  *UltracartClient::OrderApi* | [**get_order_page_view_history**](docs/OrderApi.md#get_order_page_view_history) | **GET** /order/orders/{order_id}/page_view_history | Retrieve page view history for this order.
@@ -1506,6 +1507,7 @@ Class | Method | HTTP request | Description
1506
1507
  - [UltracartClient::OrderCheckout](docs/OrderCheckout.md)
1507
1508
  - [UltracartClient::OrderCoupon](docs/OrderCoupon.md)
1508
1509
  - [UltracartClient::OrderCurrentStageHistory](docs/OrderCurrentStageHistory.md)
1510
+ - [UltracartClient::OrderCustomerActivityResponse](docs/OrderCustomerActivityResponse.md)
1509
1511
  - [UltracartClient::OrderDigitalItem](docs/OrderDigitalItem.md)
1510
1512
  - [UltracartClient::OrderDigitalOrder](docs/OrderDigitalOrder.md)
1511
1513
  - [UltracartClient::OrderEdi](docs/OrderEdi.md)
@@ -1834,6 +1836,7 @@ Not every change is committed to every SDK.
1834
1836
 
1835
1837
  | Version | Date | Comments |
1836
1838
  | --: | :-: | --- |
1839
+ | 4.1.130 | 08/17/2026 | order api - new method to obtain customer activity similar to the customer endpoint for a profile |
1837
1840
  | 4.1.129 | 08/13/2026 | ChannelPartnerOrder and OrderChannelPartner were missing a property |
1838
1841
  | 4.1.128 | 08/13/2026 | channel partner - added arbitrary discount to ChannelPartnerOrder |
1839
1842
  | 4.1.127 | 08/13/2026 | added arbitrary discounts to order creation for historical imports |
data/docs/AutoOrder.md CHANGED
@@ -9,15 +9,15 @@
9
9
  | **auto_order_oid** | **Integer** | Auto order object identifier | [optional] |
10
10
  | **cancel_after_next_x_orders** | **Integer** | Cancel this auto order after X additional rebills | [optional] |
11
11
  | **cancel_downgrade** | **Boolean** | True if the auto order was canceled because the customer purchased a downgrade item | [optional] |
12
- | **cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer | [optional] |
12
+ | **cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer. Supplying this when setting enabled to false records the change as a cancellation rather than a disable. | [optional] |
13
13
  | **cancel_upgrade** | **Boolean** | True if the auto order was canceled because the customer purchased an upgrade item | [optional] |
14
- | **canceled_by_user** | **String** | The user that canceled the auto order | [optional] |
15
- | **canceled_dts** | **String** | The date/time that the auto order was canceled | [optional] |
14
+ | **canceled_by_user** | **String** | The user that canceled the auto order. Supplying this when setting enabled to false records the change as a cancellation rather than a disable. | [optional] |
15
+ | **canceled_dts** | **String** | The date/time that the auto order was canceled. Supply this to record an explicit cancellation time, otherwise it is stamped automatically when enabled is set to false along with cancel_reason or canceled_by_user. | [optional] |
16
16
  | **completed** | **Boolean** | True if the auto order ran successfully to completion | [optional] |
17
17
  | **credit_card_attempt** | **Integer** | The number of credit card attempts that have taken place | [optional] |
18
- | **disabled_dts** | **String** | The date/time the auto order was disabled due to failed rebills | [optional] |
18
+ | **disabled_dts** | **String** | The date/time the auto order was disabled, either by a failed rebill or by setting enabled to false without a cancellation | [optional] |
19
19
  | **emails** | [**Array<AutoOrderEmail>**](AutoOrderEmail.md) | Email delivery records associated with this auto order. | [optional] |
20
- | **enabled** | **Boolean** | True if this auto order is enabled | [optional] |
20
+ | **enabled** | **Boolean** | True if this auto order is enabled. Setting this to false along with cancel_reason or canceled_by_user records the change as a cancellation and fires the auto order cancel notifications. Setting it to false without either field records a disable instead. | [optional] |
21
21
  | **failure_reason** | **String** | The reason this auto order failed during the last rebill attempt | [optional] |
22
22
  | **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] |
23
23
  | **logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional] |
data/docs/AutoOrderApi.md CHANGED
@@ -1280,7 +1280,7 @@ end
1280
1280
 
1281
1281
  Update an auto order
1282
1282
 
1283
- Update an auto order on the UltraCart account.
1283
+ Update an auto order on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1284
1284
 
1285
1285
 
1286
1286
  ### Examples
@@ -1602,7 +1602,7 @@ end
1602
1602
 
1603
1603
  Update multiple auto orders
1604
1604
 
1605
- Update multiple auto orders on the UltraCart account.
1605
+ Update multiple auto orders on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1606
1606
 
1607
1607
 
1608
1608
  ### Examples
data/docs/OrderApi.md CHANGED
@@ -21,6 +21,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
21
21
  | [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics |
22
22
  | [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order |
23
23
  | [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token |
24
+ | [**get_order_customer_activity**](OrderApi.md#get_order_customer_activity) | **GET** /order/orders/{order_id}/customer_activity | Retrieve customer activity for this order. |
24
25
  | [**get_order_edi_documents**](OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order. |
25
26
  | [**get_order_emails**](OrderApi.md#get_order_emails) | **GET** /order/orders/{order_id}/emails | Retrieve email delivery information for this order. |
26
27
  | [**get_order_page_view_history**](OrderApi.md#get_order_page_view_history) | **GET** /order/orders/{order_id}/page_view_history | Retrieve page view history for this order. |
@@ -1288,6 +1289,59 @@ end
1288
1289
  - **Accept**: application/json
1289
1290
 
1290
1291
 
1292
+ ## get_order_customer_activity
1293
+
1294
+ > <OrderCustomerActivityResponse> get_order_customer_activity(order_id)
1295
+
1296
+ Retrieve customer activity for this order.
1297
+
1298
+ Retrieves the customer activity associated with the email address on this order. This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status. A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established. For the page views captured during the session that placed the order, see the page view history method instead.
1299
+
1300
+
1301
+ ### Examples
1302
+
1303
+
1304
+ (No example for this operation).
1305
+
1306
+
1307
+ #### Using the get_order_customer_activity_with_http_info variant
1308
+
1309
+ This returns an Array which contains the response data, status code and headers.
1310
+
1311
+ > <Array(<OrderCustomerActivityResponse>, Integer, Hash)> get_order_customer_activity_with_http_info(order_id)
1312
+
1313
+ ```ruby
1314
+ begin
1315
+ # Retrieve customer activity for this order.
1316
+ data, status_code, headers = api_instance.get_order_customer_activity_with_http_info(order_id)
1317
+ p status_code # => 2xx
1318
+ p headers # => { ... }
1319
+ p data # => <OrderCustomerActivityResponse>
1320
+ rescue UltracartClient::ApiError => e
1321
+ puts "Error when calling OrderApi->get_order_customer_activity_with_http_info: #{e}"
1322
+ end
1323
+ ```
1324
+
1325
+ ### Parameters
1326
+
1327
+ | Name | Type | Description | Notes |
1328
+ | ---- | ---- | ----------- | ----- |
1329
+ | **order_id** | **String** | The order id to retrieve customer activity for. | |
1330
+
1331
+ ### Return type
1332
+
1333
+ [**OrderCustomerActivityResponse**](OrderCustomerActivityResponse.md)
1334
+
1335
+ ### Authorization
1336
+
1337
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1338
+
1339
+ ### HTTP request headers
1340
+
1341
+ - **Content-Type**: Not defined
1342
+ - **Accept**: application/json
1343
+
1344
+
1291
1345
  ## get_order_edi_documents
1292
1346
 
1293
1347
  > <OrderEdiDocumentsResponse> get_order_edi_documents(order_id)
@@ -0,0 +1,28 @@
1
+ # UltracartClient::OrderCustomerActivityResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **customer_activity** | [**CustomerActivity**](CustomerActivity.md) | | [optional] |
8
+ | **email** | **String** | Email address on the order that the customer activity was retrieved for | [optional] |
9
+ | **error** | [**Error**](Error.md) | | [optional] |
10
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
11
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
12
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::OrderCustomerActivityResponse.new(
20
+ customer_activity: null,
21
+ email: null,
22
+ error: null,
23
+ metadata: null,
24
+ success: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -1006,7 +1006,7 @@ module UltracartClient
1006
1006
  end
1007
1007
 
1008
1008
  # Update an auto order
1009
- # Update an auto order on the UltraCart account.
1009
+ # Update an auto order on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1010
1010
  # @param auto_order_oid [Integer] The auto order oid to update.
1011
1011
  # @param auto_order [AutoOrder] Auto order to update
1012
1012
  # @param [Hash] opts the optional parameters
@@ -1019,7 +1019,7 @@ module UltracartClient
1019
1019
  end
1020
1020
 
1021
1021
  # Update an auto order
1022
- # Update an auto order on the UltraCart account.
1022
+ # Update an auto order on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1023
1023
  # @param auto_order_oid [Integer] The auto order oid to update.
1024
1024
  # @param auto_order [AutoOrder] Auto order to update
1025
1025
  # @param [Hash] opts the optional parameters
@@ -1411,7 +1411,7 @@ module UltracartClient
1411
1411
  end
1412
1412
 
1413
1413
  # Update multiple auto orders
1414
- # Update multiple auto orders on the UltraCart account.
1414
+ # Update multiple auto orders on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1415
1415
  # @param auto_orders_request [AutoOrdersRequest] Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
1416
1416
  # @param [Hash] opts the optional parameters
1417
1417
  # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
@@ -1424,7 +1424,7 @@ module UltracartClient
1424
1424
  end
1425
1425
 
1426
1426
  # Update multiple auto orders
1427
- # Update multiple auto orders on the UltraCart account.
1427
+ # Update multiple auto orders on the UltraCart account. To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications. Setting enabled to false without either field records a disable.
1428
1428
  # @param auto_orders_request [AutoOrdersRequest] Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
1429
1429
  # @param [Hash] opts the optional parameters
1430
1430
  # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
@@ -1172,6 +1172,70 @@ module UltracartClient
1172
1172
  return data, status_code, headers
1173
1173
  end
1174
1174
 
1175
+ # Retrieve customer activity for this order.
1176
+ # Retrieves the customer activity associated with the email address on this order. This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status. A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established. For the page views captured during the session that placed the order, see the page view history method instead.
1177
+ # @param order_id [String] The order id to retrieve customer activity for.
1178
+ # @param [Hash] opts the optional parameters
1179
+ # @return [OrderCustomerActivityResponse]
1180
+ def get_order_customer_activity(order_id, opts = {})
1181
+ data, _status_code, _headers = get_order_customer_activity_with_http_info(order_id, opts)
1182
+ data
1183
+ end
1184
+
1185
+ # Retrieve customer activity for this order.
1186
+ # Retrieves the customer activity associated with the email address on this order. This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status. A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established. For the page views captured during the session that placed the order, see the page view history method instead.
1187
+ # @param order_id [String] The order id to retrieve customer activity for.
1188
+ # @param [Hash] opts the optional parameters
1189
+ # @return [Array<(OrderCustomerActivityResponse, Integer, Hash)>] OrderCustomerActivityResponse data, response status code and response headers
1190
+ def get_order_customer_activity_with_http_info(order_id, opts = {})
1191
+ if @api_client.config.debugging
1192
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_order_customer_activity ...'
1193
+ end
1194
+ # verify the required parameter 'order_id' is set
1195
+ if @api_client.config.client_side_validation && order_id.nil?
1196
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_customer_activity"
1197
+ end
1198
+ # resource path
1199
+ local_var_path = '/order/orders/{order_id}/customer_activity'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1200
+
1201
+ # query parameters
1202
+ query_params = opts[:query_params] || {}
1203
+
1204
+ # header parameters
1205
+ header_params = opts[:header_params] || {}
1206
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1207
+ # HTTP header 'Accept' (if needed)
1208
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1209
+
1210
+ # form parameters
1211
+ form_params = opts[:form_params] || {}
1212
+
1213
+ # http body (model)
1214
+ post_body = opts[:debug_body]
1215
+
1216
+ # return_type
1217
+ return_type = opts[:debug_return_type] || 'OrderCustomerActivityResponse'
1218
+
1219
+ # auth_names
1220
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1221
+
1222
+ new_options = opts.merge(
1223
+ :operation => :"OrderApi.get_order_customer_activity",
1224
+ :header_params => header_params,
1225
+ :query_params => query_params,
1226
+ :form_params => form_params,
1227
+ :body => post_body,
1228
+ :auth_names => auth_names,
1229
+ :return_type => return_type
1230
+ )
1231
+
1232
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1233
+ if @api_client.config.debugging
1234
+ @api_client.config.logger.debug "API called: OrderApi#get_order_customer_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1235
+ end
1236
+ return data, status_code, headers
1237
+ end
1238
+
1175
1239
  # Retrieve EDI documents associated with this order.
1176
1240
  # Retrieve EDI documents associated with this order.
1177
1241
  # @param order_id [String] The order id to retrieve EDI documents for.
@@ -30,16 +30,16 @@ module UltracartClient
30
30
  # True if the auto order was canceled because the customer purchased a downgrade item
31
31
  attr_accessor :cancel_downgrade
32
32
 
33
- # The reason this auto order was canceled by either merchant or customer
33
+ # The reason this auto order was canceled by either merchant or customer. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
34
34
  attr_accessor :cancel_reason
35
35
 
36
36
  # True if the auto order was canceled because the customer purchased an upgrade item
37
37
  attr_accessor :cancel_upgrade
38
38
 
39
- # The user that canceled the auto order
39
+ # The user that canceled the auto order. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
40
40
  attr_accessor :canceled_by_user
41
41
 
42
- # The date/time that the auto order was canceled
42
+ # The date/time that the auto order was canceled. Supply this to record an explicit cancellation time, otherwise it is stamped automatically when enabled is set to false along with cancel_reason or canceled_by_user.
43
43
  attr_accessor :canceled_dts
44
44
 
45
45
  # True if the auto order ran successfully to completion
@@ -48,13 +48,13 @@ module UltracartClient
48
48
  # The number of credit card attempts that have taken place
49
49
  attr_accessor :credit_card_attempt
50
50
 
51
- # The date/time the auto order was disabled due to failed rebills
51
+ # The date/time the auto order was disabled, either by a failed rebill or by setting enabled to false without a cancellation
52
52
  attr_accessor :disabled_dts
53
53
 
54
54
  # Email delivery records associated with this auto order.
55
55
  attr_accessor :emails
56
56
 
57
- # True if this auto order is enabled
57
+ # True if this auto order is enabled. Setting this to false along with cancel_reason or canceled_by_user records the change as a cancellation and fires the auto order cancel notifications. Setting it to false without either field records a disable instead.
58
58
  attr_accessor :enabled
59
59
 
60
60
  # The reason this auto order failed during the last rebill attempt
@@ -0,0 +1,266 @@
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 OrderCustomerActivityResponse
18
+ attr_accessor :customer_activity
19
+
20
+ # Email address on the order that the customer activity was retrieved for
21
+ attr_accessor :email
22
+
23
+ attr_accessor :error
24
+
25
+ attr_accessor :metadata
26
+
27
+ # Indicates if API call was successful
28
+ attr_accessor :success
29
+
30
+ attr_accessor :warning
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'customer_activity' => :'customer_activity',
36
+ :'email' => :'email',
37
+ :'error' => :'error',
38
+ :'metadata' => :'metadata',
39
+ :'success' => :'success',
40
+ :'warning' => :'warning'
41
+ }
42
+ end
43
+
44
+ # Returns all the JSON keys this model knows about
45
+ def self.acceptable_attributes
46
+ attribute_map.values
47
+ end
48
+
49
+ # Attribute type mapping.
50
+ def self.openapi_types
51
+ {
52
+ :'customer_activity' => :'CustomerActivity',
53
+ :'email' => :'String',
54
+ :'error' => :'Error',
55
+ :'metadata' => :'ResponseMetadata',
56
+ :'success' => :'Boolean',
57
+ :'warning' => :'Warning'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ ])
65
+ end
66
+
67
+ # Initializes the object
68
+ # @param [Hash] attributes Model attributes in the form of hash
69
+ def initialize(attributes = {})
70
+ if (!attributes.is_a?(Hash))
71
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderCustomerActivityResponse` initialize method"
72
+ end
73
+
74
+ # check to see if the attribute exists and convert string to symbol for hash key
75
+ attributes = attributes.each_with_object({}) { |(k, v), h|
76
+ if (!self.class.attribute_map.key?(k.to_sym))
77
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderCustomerActivityResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
78
+ end
79
+ h[k.to_sym] = v
80
+ }
81
+
82
+ if attributes.key?(:'customer_activity')
83
+ self.customer_activity = attributes[:'customer_activity']
84
+ end
85
+
86
+ if attributes.key?(:'email')
87
+ self.email = attributes[:'email']
88
+ end
89
+
90
+ if attributes.key?(:'error')
91
+ self.error = attributes[:'error']
92
+ end
93
+
94
+ if attributes.key?(:'metadata')
95
+ self.metadata = attributes[:'metadata']
96
+ end
97
+
98
+ if attributes.key?(:'success')
99
+ self.success = attributes[:'success']
100
+ end
101
+
102
+ if attributes.key?(:'warning')
103
+ self.warning = attributes[:'warning']
104
+ end
105
+ end
106
+
107
+ # Show invalid properties with the reasons. Usually used together with valid?
108
+ # @return Array for valid properties with the reasons
109
+ def list_invalid_properties
110
+ invalid_properties = Array.new
111
+ invalid_properties
112
+ end
113
+
114
+ # Check to see if the all the properties in the model are valid
115
+ # @return true if the model is valid
116
+ def valid?
117
+ true
118
+ end
119
+
120
+ # Checks equality by comparing each attribute.
121
+ # @param [Object] Object to be compared
122
+ def ==(o)
123
+ return true if self.equal?(o)
124
+ self.class == o.class &&
125
+ customer_activity == o.customer_activity &&
126
+ email == o.email &&
127
+ error == o.error &&
128
+ metadata == o.metadata &&
129
+ success == o.success &&
130
+ warning == o.warning
131
+ end
132
+
133
+ # @see the `==` method
134
+ # @param [Object] Object to be compared
135
+ def eql?(o)
136
+ self == o
137
+ end
138
+
139
+ # Calculates hash code according to all attributes.
140
+ # @return [Integer] Hash code
141
+ def hash
142
+ [customer_activity, email, error, metadata, success, warning].hash
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 self.build_from_hash(attributes)
149
+ new.build_from_hash(attributes)
150
+ end
151
+
152
+ # Builds the object from hash
153
+ # @param [Hash] attributes Model attributes in the form of hash
154
+ # @return [Object] Returns the model itself
155
+ def build_from_hash(attributes)
156
+ return nil unless attributes.is_a?(Hash)
157
+ attributes = attributes.transform_keys(&:to_sym)
158
+ self.class.openapi_types.each_pair do |key, type|
159
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
160
+ self.send("#{key}=", nil)
161
+ elsif type =~ /\AArray<(.*)>/i
162
+ # check to ensure the input is an array given that the attribute
163
+ # is documented as an array but the input is not
164
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
165
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
166
+ end
167
+ elsif !attributes[self.class.attribute_map[key]].nil?
168
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
169
+ end
170
+ end
171
+
172
+ self
173
+ end
174
+
175
+ # Deserializes the data based on type
176
+ # @param string type Data type
177
+ # @param string value Value to be deserialized
178
+ # @return [Object] Deserialized data
179
+ def _deserialize(type, value)
180
+ case type.to_sym
181
+ when :Time
182
+ Time.parse(value)
183
+ when :Date
184
+ Date.parse(value)
185
+ when :String
186
+ value.to_s
187
+ when :Integer
188
+ value.to_i
189
+ when :Float
190
+ value.to_f
191
+ when :Boolean
192
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
193
+ true
194
+ else
195
+ false
196
+ end
197
+ when :Object
198
+ # generic object (usually a Hash), return directly
199
+ value
200
+ when /\AArray<(?<inner_type>.+)>\z/
201
+ inner_type = Regexp.last_match[:inner_type]
202
+ value.map { |v| _deserialize(inner_type, v) }
203
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
204
+ k_type = Regexp.last_match[:k_type]
205
+ v_type = Regexp.last_match[:v_type]
206
+ {}.tap do |hash|
207
+ value.each do |k, v|
208
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
209
+ end
210
+ end
211
+ else # model
212
+ # models (e.g. Pet) or oneOf
213
+ klass = UltracartClient.const_get(type)
214
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
215
+ end
216
+ end
217
+
218
+ # Returns the string representation of the object
219
+ # @return [String] String presentation of the object
220
+ def to_s
221
+ to_hash.to_s
222
+ end
223
+
224
+ # to_body is an alias to to_hash (backward compatibility)
225
+ # @return [Hash] Returns the object in the form of hash
226
+ def to_body
227
+ to_hash
228
+ end
229
+
230
+ # Returns the object in the form of hash
231
+ # @return [Hash] Returns the object in the form of hash
232
+ def to_hash
233
+ hash = {}
234
+ self.class.attribute_map.each_pair do |attr, param|
235
+ value = self.send(attr)
236
+ if value.nil?
237
+ is_nullable = self.class.openapi_nullable.include?(attr)
238
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
239
+ end
240
+
241
+ hash[param] = _to_hash(value)
242
+ end
243
+ hash
244
+ end
245
+
246
+ # Outputs non-array value in the form of hash
247
+ # For object, use to_hash. Otherwise, just return the value
248
+ # @param [Object] value Any valid value
249
+ # @return [Hash] Returns the value in the form of hash
250
+ def _to_hash(value)
251
+ if value.is_a?(Array)
252
+ value.compact.map { |v| _to_hash(v) }
253
+ elsif value.is_a?(Hash)
254
+ {}.tap do |hash|
255
+ value.each { |k, v| hash[k] = _to_hash(v) }
256
+ end
257
+ elsif value.respond_to? :to_hash
258
+ value.to_hash
259
+ else
260
+ value
261
+ end
262
+ end
263
+
264
+ end
265
+
266
+ end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.129'
14
+ VERSION = '4.1.130'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -802,6 +802,7 @@ require 'ultracart_api/models/order_channel_partner'
802
802
  require 'ultracart_api/models/order_checkout'
803
803
  require 'ultracart_api/models/order_coupon'
804
804
  require 'ultracart_api/models/order_current_stage_history'
805
+ require 'ultracart_api/models/order_customer_activity_response'
805
806
  require 'ultracart_api/models/order_digital_item'
806
807
  require 'ultracart_api/models/order_digital_order'
807
808
  require 'ultracart_api/models/order_edi'
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.129
4
+ version: 4.1.130
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-13 00:00:00.000000000 Z
11
+ date: 2026-08-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -863,6 +863,7 @@ files:
863
863
  - docs/OrderCheckout.md
864
864
  - docs/OrderCoupon.md
865
865
  - docs/OrderCurrentStageHistory.md
866
+ - docs/OrderCustomerActivityResponse.md
866
867
  - docs/OrderDigitalItem.md
867
868
  - docs/OrderDigitalOrder.md
868
869
  - docs/OrderEdi.md
@@ -1935,6 +1936,7 @@ files:
1935
1936
  - lib/ultracart_api/models/order_checkout.rb
1936
1937
  - lib/ultracart_api/models/order_coupon.rb
1937
1938
  - lib/ultracart_api/models/order_current_stage_history.rb
1939
+ - lib/ultracart_api/models/order_customer_activity_response.rb
1938
1940
  - lib/ultracart_api/models/order_digital_item.rb
1939
1941
  - lib/ultracart_api/models/order_digital_order.rb
1940
1942
  - lib/ultracart_api/models/order_edi.rb