ultracart_api 4.1.19 → 4.1.20

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.
@@ -14,13 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module UltracartClient
17
- class ChargebackDisputesResponse
18
- attr_accessor :chargebacks
19
-
17
+ class CustomDashboardSchedulesResponse
20
18
  attr_accessor :error
21
19
 
22
20
  attr_accessor :metadata
23
21
 
22
+ # schedules
23
+ attr_accessor :schedules
24
+
24
25
  # Indicates if API call was successful
25
26
  attr_accessor :success
26
27
 
@@ -29,9 +30,9 @@ module UltracartClient
29
30
  # Attribute mapping from ruby-style variable name to JSON key.
30
31
  def self.attribute_map
31
32
  {
32
- :'chargebacks' => :'chargebacks',
33
33
  :'error' => :'error',
34
34
  :'metadata' => :'metadata',
35
+ :'schedules' => :'schedules',
35
36
  :'success' => :'success',
36
37
  :'warning' => :'warning'
37
38
  }
@@ -45,9 +46,9 @@ module UltracartClient
45
46
  # Attribute type mapping.
46
47
  def self.openapi_types
47
48
  {
48
- :'chargebacks' => :'Array<ChargebackDispute>',
49
49
  :'error' => :'Error',
50
50
  :'metadata' => :'ResponseMetadata',
51
+ :'schedules' => :'Array<CustomDashboardSchedule>',
51
52
  :'success' => :'Boolean',
52
53
  :'warning' => :'Warning'
53
54
  }
@@ -63,23 +64,17 @@ module UltracartClient
63
64
  # @param [Hash] attributes Model attributes in the form of hash
64
65
  def initialize(attributes = {})
65
66
  if (!attributes.is_a?(Hash))
66
- fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ChargebackDisputesResponse` initialize method"
67
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CustomDashboardSchedulesResponse` initialize method"
67
68
  end
68
69
 
69
70
  # check to see if the attribute exists and convert string to symbol for hash key
70
71
  attributes = attributes.each_with_object({}) { |(k, v), h|
71
72
  if (!self.class.attribute_map.key?(k.to_sym))
72
- fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ChargebackDisputesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CustomDashboardSchedulesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
73
74
  end
74
75
  h[k.to_sym] = v
75
76
  }
76
77
 
77
- if attributes.key?(:'chargebacks')
78
- if (value = attributes[:'chargebacks']).is_a?(Array)
79
- self.chargebacks = value
80
- end
81
- end
82
-
83
78
  if attributes.key?(:'error')
84
79
  self.error = attributes[:'error']
85
80
  end
@@ -88,6 +83,12 @@ module UltracartClient
88
83
  self.metadata = attributes[:'metadata']
89
84
  end
90
85
 
86
+ if attributes.key?(:'schedules')
87
+ if (value = attributes[:'schedules']).is_a?(Array)
88
+ self.schedules = value
89
+ end
90
+ end
91
+
91
92
  if attributes.key?(:'success')
92
93
  self.success = attributes[:'success']
93
94
  end
@@ -115,9 +116,9 @@ module UltracartClient
115
116
  def ==(o)
116
117
  return true if self.equal?(o)
117
118
  self.class == o.class &&
118
- chargebacks == o.chargebacks &&
119
119
  error == o.error &&
120
120
  metadata == o.metadata &&
121
+ schedules == o.schedules &&
121
122
  success == o.success &&
122
123
  warning == o.warning
123
124
  end
@@ -131,7 +132,7 @@ module UltracartClient
131
132
  # Calculates hash code according to all attributes.
132
133
  # @return [Integer] Hash code
133
134
  def hash
134
- [chargebacks, error, metadata, success, warning].hash
135
+ [error, metadata, schedules, success, warning].hash
135
136
  end
136
137
 
137
138
  # Builds the object from hash
@@ -15,6 +15,8 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class CustomReport
18
+ attr_accessor :business_analysis_prompt
19
+
18
20
  attr_accessor :chart_javascript
19
21
 
20
22
  attr_accessor :chart_javascript_url
@@ -38,6 +40,7 @@ module UltracartClient
38
40
  # Attribute mapping from ruby-style variable name to JSON key.
39
41
  def self.attribute_map
40
42
  {
43
+ :'business_analysis_prompt' => :'business_analysis_prompt',
41
44
  :'chart_javascript' => :'chart_javascript',
42
45
  :'chart_javascript_url' => :'chart_javascript_url',
43
46
  :'data_warehouse_report_config_oid' => :'data_warehouse_report_config_oid',
@@ -59,6 +62,7 @@ module UltracartClient
59
62
  # Attribute type mapping.
60
63
  def self.openapi_types
61
64
  {
65
+ :'business_analysis_prompt' => :'String',
62
66
  :'chart_javascript' => :'String',
63
67
  :'chart_javascript_url' => :'String',
64
68
  :'data_warehouse_report_config_oid' => :'Integer',
@@ -93,6 +97,10 @@ module UltracartClient
93
97
  h[k.to_sym] = v
94
98
  }
95
99
 
100
+ if attributes.key?(:'business_analysis_prompt')
101
+ self.business_analysis_prompt = attributes[:'business_analysis_prompt']
102
+ end
103
+
96
104
  if attributes.key?(:'chart_javascript')
97
105
  self.chart_javascript = attributes[:'chart_javascript']
98
106
  end
@@ -158,6 +166,7 @@ module UltracartClient
158
166
  def ==(o)
159
167
  return true if self.equal?(o)
160
168
  self.class == o.class &&
169
+ business_analysis_prompt == o.business_analysis_prompt &&
161
170
  chart_javascript == o.chart_javascript &&
162
171
  chart_javascript_url == o.chart_javascript_url &&
163
172
  data_warehouse_report_config_oid == o.data_warehouse_report_config_oid &&
@@ -179,7 +188,7 @@ module UltracartClient
179
188
  # Calculates hash code according to all attributes.
180
189
  # @return [Integer] Hash code
181
190
  def hash
182
- [chart_javascript, chart_javascript_url, data_warehouse_report_config_oid, dataset_security_level, group_name, merchant_id, name, parameters, queries, tooltips].hash
191
+ [business_analysis_prompt, chart_javascript, chart_javascript_url, data_warehouse_report_config_oid, dataset_security_level, group_name, merchant_id, name, parameters, queries, tooltips].hash
183
192
  end
184
193
 
185
194
  # Builds the object from hash
@@ -66,6 +66,12 @@ module UltracartClient
66
66
  # True if this campaign is prevented from sending at this time due to spam complaints.
67
67
  attr_accessor :prevent_sending_due_to_spam
68
68
 
69
+ # True if the campaign should repeat on a monthly basis
70
+ attr_accessor :repeat_monthly
71
+
72
+ # True if the campaign should repeat on a weekly basis
73
+ attr_accessor :repeat_weekly
74
+
69
75
  # Revenue associated with campaign
70
76
  attr_accessor :revenue_formatted
71
77
 
@@ -113,6 +119,8 @@ module UltracartClient
113
119
  :'name' => :'name',
114
120
  :'open_rate_formatted' => :'open_rate_formatted',
115
121
  :'prevent_sending_due_to_spam' => :'prevent_sending_due_to_spam',
122
+ :'repeat_monthly' => :'repeat_monthly',
123
+ :'repeat_weekly' => :'repeat_weekly',
116
124
  :'revenue_formatted' => :'revenue_formatted',
117
125
  :'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
118
126
  :'scheduled_dts' => :'scheduled_dts',
@@ -150,6 +158,8 @@ module UltracartClient
150
158
  :'name' => :'String',
151
159
  :'open_rate_formatted' => :'String',
152
160
  :'prevent_sending_due_to_spam' => :'Boolean',
161
+ :'repeat_monthly' => :'Boolean',
162
+ :'repeat_weekly' => :'Boolean',
153
163
  :'revenue_formatted' => :'String',
154
164
  :'revenue_per_customer_formatted' => :'String',
155
165
  :'scheduled_dts' => :'String',
@@ -253,6 +263,14 @@ module UltracartClient
253
263
  self.prevent_sending_due_to_spam = attributes[:'prevent_sending_due_to_spam']
254
264
  end
255
265
 
266
+ if attributes.key?(:'repeat_monthly')
267
+ self.repeat_monthly = attributes[:'repeat_monthly']
268
+ end
269
+
270
+ if attributes.key?(:'repeat_weekly')
271
+ self.repeat_weekly = attributes[:'repeat_weekly']
272
+ end
273
+
256
274
  if attributes.key?(:'revenue_formatted')
257
275
  self.revenue_formatted = attributes[:'revenue_formatted']
258
276
  end
@@ -340,6 +358,8 @@ module UltracartClient
340
358
  name == o.name &&
341
359
  open_rate_formatted == o.open_rate_formatted &&
342
360
  prevent_sending_due_to_spam == o.prevent_sending_due_to_spam &&
361
+ repeat_monthly == o.repeat_monthly &&
362
+ repeat_weekly == o.repeat_weekly &&
343
363
  revenue_formatted == o.revenue_formatted &&
344
364
  revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
345
365
  scheduled_dts == o.scheduled_dts &&
@@ -360,7 +380,7 @@ module UltracartClient
360
380
  # Calculates hash code according to all attributes.
361
381
  # @return [Integer] Hash code
362
382
  def hash
363
- [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid].hash
383
+ [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, repeat_monthly, repeat_weekly, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid].hash
364
384
  end
365
385
 
366
386
  # Builds the object from hash
@@ -260,7 +260,7 @@ module UltracartClient
260
260
  # Check to see if the all the properties in the model are valid
261
261
  # @return true if the model is valid
262
262
  def valid?
263
- payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
263
+ payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
264
264
  return false unless payment_method_validator.valid?(@payment_method)
265
265
  payment_status_validator = EnumAttributeValidator.new('String', ["Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped"])
266
266
  return false unless payment_status_validator.valid?(@payment_status)
@@ -270,7 +270,7 @@ module UltracartClient
270
270
  # Custom attribute writer method checking allowed values (enum).
271
271
  # @param [Object] payment_method Object to be assigned
272
272
  def payment_method=(payment_method)
273
- validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
273
+ validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
274
274
  unless validator.valid?(payment_method)
275
275
  fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
276
276
  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.19'
14
+ VERSION = '4.1.20'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -137,9 +137,6 @@ require 'ultracart_api/models/channel_partner_ship_to_preference_response'
137
137
  require 'ultracart_api/models/channel_partner_ship_to_preferences_response'
138
138
  require 'ultracart_api/models/channel_partner_shipping_estimate'
139
139
  require 'ultracart_api/models/channel_partners_response'
140
- require 'ultracart_api/models/chargeback_dispute'
141
- require 'ultracart_api/models/chargeback_dispute_response'
142
- require 'ultracart_api/models/chargeback_disputes_response'
143
140
  require 'ultracart_api/models/checkout_allowed_countries_response'
144
141
  require 'ultracart_api/models/checkout_handoff_request'
145
142
  require 'ultracart_api/models/checkout_handoff_response'
@@ -327,6 +324,9 @@ require 'ultracart_api/models/custom_dashboard_execution_parameter'
327
324
  require 'ultracart_api/models/custom_dashboard_page'
328
325
  require 'ultracart_api/models/custom_dashboard_page_report'
329
326
  require 'ultracart_api/models/custom_dashboard_response'
327
+ require 'ultracart_api/models/custom_dashboard_schedule'
328
+ require 'ultracart_api/models/custom_dashboard_schedule_response'
329
+ require 'ultracart_api/models/custom_dashboard_schedules_response'
330
330
  require 'ultracart_api/models/custom_dashboards_response'
331
331
  require 'ultracart_api/models/custom_report'
332
332
  require 'ultracart_api/models/custom_report_account_config'
@@ -908,7 +908,6 @@ require 'ultracart_api/models/workflow_users_response'
908
908
  require 'ultracart_api/api/affiliate_api'
909
909
  require 'ultracart_api/api/auto_order_api'
910
910
  require 'ultracart_api/api/channel_partner_api'
911
- require 'ultracart_api/api/chargeback_api'
912
911
  require 'ultracart_api/api/checkout_api'
913
912
  require 'ultracart_api/api/conversation_api'
914
913
  require 'ultracart_api/api/coupon_api'
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.19
4
+ version: 4.1.20
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-08-04 00:00:00.000000000 Z
11
+ date: 2025-08-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -184,10 +184,6 @@ files:
184
184
  - docs/ChannelPartnerShipToPreferencesResponse.md
185
185
  - docs/ChannelPartnerShippingEstimate.md
186
186
  - docs/ChannelPartnersResponse.md
187
- - docs/ChargebackApi.md
188
- - docs/ChargebackDispute.md
189
- - docs/ChargebackDisputeResponse.md
190
- - docs/ChargebackDisputesResponse.md
191
187
  - docs/CheckoutAllowedCountriesResponse.md
192
188
  - docs/CheckoutApi.md
193
189
  - docs/CheckoutHandoffRequest.md
@@ -378,6 +374,9 @@ files:
378
374
  - docs/CustomDashboardPage.md
379
375
  - docs/CustomDashboardPageReport.md
380
376
  - docs/CustomDashboardResponse.md
377
+ - docs/CustomDashboardSchedule.md
378
+ - docs/CustomDashboardScheduleResponse.md
379
+ - docs/CustomDashboardSchedulesResponse.md
381
380
  - docs/CustomDashboardsResponse.md
382
381
  - docs/CustomReport.md
383
382
  - docs/CustomReportAccountConfig.md
@@ -973,7 +972,6 @@ files:
973
972
  - lib/ultracart_api/api/affiliate_api.rb
974
973
  - lib/ultracart_api/api/auto_order_api.rb
975
974
  - lib/ultracart_api/api/channel_partner_api.rb
976
- - lib/ultracart_api/api/chargeback_api.rb
977
975
  - lib/ultracart_api/api/checkout_api.rb
978
976
  - lib/ultracart_api/api/conversation_api.rb
979
977
  - lib/ultracart_api/api/coupon_api.rb
@@ -1114,9 +1112,6 @@ files:
1114
1112
  - lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb
1115
1113
  - lib/ultracart_api/models/channel_partner_shipping_estimate.rb
1116
1114
  - lib/ultracart_api/models/channel_partners_response.rb
1117
- - lib/ultracart_api/models/chargeback_dispute.rb
1118
- - lib/ultracart_api/models/chargeback_dispute_response.rb
1119
- - lib/ultracart_api/models/chargeback_disputes_response.rb
1120
1115
  - lib/ultracart_api/models/checkout_allowed_countries_response.rb
1121
1116
  - lib/ultracart_api/models/checkout_handoff_request.rb
1122
1117
  - lib/ultracart_api/models/checkout_handoff_response.rb
@@ -1304,6 +1299,9 @@ files:
1304
1299
  - lib/ultracart_api/models/custom_dashboard_page.rb
1305
1300
  - lib/ultracart_api/models/custom_dashboard_page_report.rb
1306
1301
  - lib/ultracart_api/models/custom_dashboard_response.rb
1302
+ - lib/ultracart_api/models/custom_dashboard_schedule.rb
1303
+ - lib/ultracart_api/models/custom_dashboard_schedule_response.rb
1304
+ - lib/ultracart_api/models/custom_dashboard_schedules_response.rb
1307
1305
  - lib/ultracart_api/models/custom_dashboards_response.rb
1308
1306
  - lib/ultracart_api/models/custom_report.rb
1309
1307
  - lib/ultracart_api/models/custom_report_account_config.rb
@@ -1,297 +0,0 @@
1
- # UltracartClient::ChargebackApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**delete_chargeback**](ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback |
8
- | [**get_chargeback_dispute**](ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback |
9
- | [**get_chargeback_disputes**](ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks |
10
- | [**insert_chargeback**](ChargebackApi.md#insert_chargeback) | **POST** /chargeback/chargebacks | Insert a chargeback |
11
- | [**update_chargeback**](ChargebackApi.md#update_chargeback) | **PUT** /chargeback/chargebacks/{chargeback_dispute_oid} | Update a chargeback |
12
-
13
-
14
- ## delete_chargeback
15
-
16
- > <ChargebackDisputeResponse> delete_chargeback(chargeback_dispute_oid)
17
-
18
- Delete a chargeback
19
-
20
- Delete a chargeback on the UltraCart account.
21
-
22
-
23
- ### Examples
24
-
25
- ```ruby
26
- # Internal API. No samples are provided as merchants will never need this api method
27
- ```
28
-
29
-
30
- #### Using the delete_chargeback_with_http_info variant
31
-
32
- This returns an Array which contains the response data, status code and headers.
33
-
34
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> delete_chargeback_with_http_info(chargeback_dispute_oid)
35
-
36
- ```ruby
37
- begin
38
- # Delete a chargeback
39
- data, status_code, headers = api_instance.delete_chargeback_with_http_info(chargeback_dispute_oid)
40
- p status_code # => 2xx
41
- p headers # => { ... }
42
- p data # => <ChargebackDisputeResponse>
43
- rescue UltracartClient::ApiError => e
44
- puts "Error when calling ChargebackApi->delete_chargeback_with_http_info: #{e}"
45
- end
46
- ```
47
-
48
- ### Parameters
49
-
50
- | Name | Type | Description | Notes |
51
- | ---- | ---- | ----------- | ----- |
52
- | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to delete. | |
53
-
54
- ### Return type
55
-
56
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
57
-
58
- ### Authorization
59
-
60
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
61
-
62
- ### HTTP request headers
63
-
64
- - **Content-Type**: Not defined
65
- - **Accept**: application/json
66
-
67
-
68
- ## get_chargeback_dispute
69
-
70
- > <ChargebackDisputeResponse> get_chargeback_dispute(chargeback_dispute_oid, opts)
71
-
72
- Retrieve a chargeback
73
-
74
- Retrieves a single chargeback using the specified chargeback dispute oid.
75
-
76
-
77
- ### Examples
78
-
79
- ```ruby
80
- # Internal API. No samples are provided as merchants will never need this api method
81
- ```
82
-
83
-
84
- #### Using the get_chargeback_dispute_with_http_info variant
85
-
86
- This returns an Array which contains the response data, status code and headers.
87
-
88
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
89
-
90
- ```ruby
91
- begin
92
- # Retrieve a chargeback
93
- data, status_code, headers = api_instance.get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
94
- p status_code # => 2xx
95
- p headers # => { ... }
96
- p data # => <ChargebackDisputeResponse>
97
- rescue UltracartClient::ApiError => e
98
- puts "Error when calling ChargebackApi->get_chargeback_dispute_with_http_info: #{e}"
99
- end
100
- ```
101
-
102
- ### Parameters
103
-
104
- | Name | Type | Description | Notes |
105
- | ---- | ---- | ----------- | ----- |
106
- | **chargeback_dispute_oid** | **Integer** | The chargeback dispute oid to retrieve. | |
107
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
108
-
109
- ### Return type
110
-
111
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
112
-
113
- ### Authorization
114
-
115
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
116
-
117
- ### HTTP request headers
118
-
119
- - **Content-Type**: Not defined
120
- - **Accept**: application/json
121
-
122
-
123
- ## get_chargeback_disputes
124
-
125
- > <ChargebackDisputesResponse> get_chargeback_disputes(opts)
126
-
127
- Retrieve chargebacks
128
-
129
- Retrieves chargebacks from the account. If no parameters are specified, all chargebacks will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
130
-
131
-
132
- ### Examples
133
-
134
- ```ruby
135
- # Internal API. No samples are provided as merchants will never need this api method
136
- ```
137
-
138
-
139
- #### Using the get_chargeback_disputes_with_http_info variant
140
-
141
- This returns an Array which contains the response data, status code and headers.
142
-
143
- > <Array(<ChargebackDisputesResponse>, Integer, Hash)> get_chargeback_disputes_with_http_info(opts)
144
-
145
- ```ruby
146
- begin
147
- # Retrieve chargebacks
148
- data, status_code, headers = api_instance.get_chargeback_disputes_with_http_info(opts)
149
- p status_code # => 2xx
150
- p headers # => { ... }
151
- p data # => <ChargebackDisputesResponse>
152
- rescue UltracartClient::ApiError => e
153
- puts "Error when calling ChargebackApi->get_chargeback_disputes_with_http_info: #{e}"
154
- end
155
- ```
156
-
157
- ### Parameters
158
-
159
- | Name | Type | Description | Notes |
160
- | ---- | ---- | ----------- | ----- |
161
- | **order_id** | **String** | Order Id | [optional] |
162
- | **case_number** | **String** | Case number | [optional] |
163
- | **status** | **String** | Status | [optional] |
164
- | **expiration_dts_start** | **String** | Expiration dts start | [optional] |
165
- | **expiration_dts_end** | **String** | Expiration dts end | [optional] |
166
- | **chargeback_dts_start** | **String** | Chargeback dts start | [optional] |
167
- | **chargeback_dts_end** | **String** | Chargeback dts end | [optional] |
168
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
169
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
170
- | **_since** | **String** | Fetch chargebacks that have been created/modified since this date/time. | [optional] |
171
- | **_sort** | **String** | The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
172
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
173
-
174
- ### Return type
175
-
176
- [**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
177
-
178
- ### Authorization
179
-
180
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
181
-
182
- ### HTTP request headers
183
-
184
- - **Content-Type**: Not defined
185
- - **Accept**: application/json
186
-
187
-
188
- ## insert_chargeback
189
-
190
- > <ChargebackDisputeResponse> insert_chargeback(chargeback, opts)
191
-
192
- Insert a chargeback
193
-
194
- Insert a chargeback on the UltraCart account.
195
-
196
-
197
- ### Examples
198
-
199
- ```ruby
200
- # Internal API. No samples are provided as merchants will never need this api method
201
- ```
202
-
203
-
204
- #### Using the insert_chargeback_with_http_info variant
205
-
206
- This returns an Array which contains the response data, status code and headers.
207
-
208
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> insert_chargeback_with_http_info(chargeback, opts)
209
-
210
- ```ruby
211
- begin
212
- # Insert a chargeback
213
- data, status_code, headers = api_instance.insert_chargeback_with_http_info(chargeback, opts)
214
- p status_code # => 2xx
215
- p headers # => { ... }
216
- p data # => <ChargebackDisputeResponse>
217
- rescue UltracartClient::ApiError => e
218
- puts "Error when calling ChargebackApi->insert_chargeback_with_http_info: #{e}"
219
- end
220
- ```
221
-
222
- ### Parameters
223
-
224
- | Name | Type | Description | Notes |
225
- | ---- | ---- | ----------- | ----- |
226
- | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to insert | |
227
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
228
-
229
- ### Return type
230
-
231
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
232
-
233
- ### Authorization
234
-
235
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
236
-
237
- ### HTTP request headers
238
-
239
- - **Content-Type**: application/json; charset=UTF-8
240
- - **Accept**: application/json
241
-
242
-
243
- ## update_chargeback
244
-
245
- > <ChargebackDisputeResponse> update_chargeback(chargeback_dispute_oid, chargeback, opts)
246
-
247
- Update a chargeback
248
-
249
- Update a chargeback on the UltraCart account.
250
-
251
-
252
- ### Examples
253
-
254
- ```ruby
255
- # Internal API. No samples are provided as merchants will never need this api method
256
- ```
257
-
258
-
259
- #### Using the update_chargeback_with_http_info variant
260
-
261
- This returns an Array which contains the response data, status code and headers.
262
-
263
- > <Array(<ChargebackDisputeResponse>, Integer, Hash)> update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
264
-
265
- ```ruby
266
- begin
267
- # Update a chargeback
268
- data, status_code, headers = api_instance.update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
269
- p status_code # => 2xx
270
- p headers # => { ... }
271
- p data # => <ChargebackDisputeResponse>
272
- rescue UltracartClient::ApiError => e
273
- puts "Error when calling ChargebackApi->update_chargeback_with_http_info: #{e}"
274
- end
275
- ```
276
-
277
- ### Parameters
278
-
279
- | Name | Type | Description | Notes |
280
- | ---- | ---- | ----------- | ----- |
281
- | **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to update. | |
282
- | **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to update | |
283
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
284
-
285
- ### Return type
286
-
287
- [**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
288
-
289
- ### Authorization
290
-
291
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
292
-
293
- ### HTTP request headers
294
-
295
- - **Content-Type**: application/json; charset=UTF-8
296
- - **Accept**: application/json
297
-