ultracart_api 3.11.18 → 3.11.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.
- checksums.yaml +4 -4
- data/README.md +15 -12
- data/docs/ConversationVirtualAgentCapabilities.md +3 -0
- data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +9 -0
- data/docs/CustomDashboard.md +1 -0
- data/docs/CustomDashboardExecutionParameter.md +11 -0
- data/docs/CustomDashboardSchedule.md +12 -0
- data/docs/{ChargebackDisputeResponse.md → CustomDashboardScheduleResponse.md} +2 -2
- data/docs/{ChargebackDisputesResponse.md → CustomDashboardSchedulesResponse.md} +2 -2
- data/docs/CustomReport.md +1 -0
- data/docs/CustomReportExecutionParameter.md +1 -0
- data/docs/DatawarehouseApi.md +215 -0
- data/docs/EmailCampaign.md +2 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +243 -0
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +38 -6
- data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +193 -0
- data/lib/ultracart_api/models/custom_dashboard.rb +15 -4
- data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +211 -0
- data/lib/ultracart_api/models/custom_dashboard_schedule.rb +223 -0
- data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +11 -11
- data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +14 -13
- data/lib/ultracart_api/models/custom_report.rb +10 -1
- data/lib/ultracart_api/models/custom_report_execution_parameter.rb +10 -1
- data/lib/ultracart_api/models/email_campaign.rb +21 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -4
- metadata +12 -10
- data/docs/ChargebackApi.md +0 -301
- data/docs/ChargebackDispute.md +0 -30
- data/lib/ultracart_api/api/chargeback_api.rb +0 -356
- data/lib/ultracart_api/models/chargeback_dispute.rb +0 -614
@@ -65,6 +65,12 @@ module UltracartClient
|
|
65
65
|
# True if this campaign is prevented from sending at this time due to spam complaints.
|
66
66
|
attr_accessor :prevent_sending_due_to_spam
|
67
67
|
|
68
|
+
# True if the campaign should repeat on a monthly basis
|
69
|
+
attr_accessor :repeat_monthly
|
70
|
+
|
71
|
+
# True if the campaign should repeat on a weekly basis
|
72
|
+
attr_accessor :repeat_weekly
|
73
|
+
|
68
74
|
# Revenue associated with campaign
|
69
75
|
attr_accessor :revenue_formatted
|
70
76
|
|
@@ -112,6 +118,8 @@ module UltracartClient
|
|
112
118
|
:'name' => :'name',
|
113
119
|
:'open_rate_formatted' => :'open_rate_formatted',
|
114
120
|
:'prevent_sending_due_to_spam' => :'prevent_sending_due_to_spam',
|
121
|
+
:'repeat_monthly' => :'repeat_monthly',
|
122
|
+
:'repeat_weekly' => :'repeat_weekly',
|
115
123
|
:'revenue_formatted' => :'revenue_formatted',
|
116
124
|
:'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
|
117
125
|
:'scheduled_dts' => :'scheduled_dts',
|
@@ -144,6 +152,8 @@ module UltracartClient
|
|
144
152
|
:'name' => :'String',
|
145
153
|
:'open_rate_formatted' => :'String',
|
146
154
|
:'prevent_sending_due_to_spam' => :'BOOLEAN',
|
155
|
+
:'repeat_monthly' => :'BOOLEAN',
|
156
|
+
:'repeat_weekly' => :'BOOLEAN',
|
147
157
|
:'revenue_formatted' => :'String',
|
148
158
|
:'revenue_per_customer_formatted' => :'String',
|
149
159
|
:'scheduled_dts' => :'String',
|
@@ -234,6 +244,14 @@ module UltracartClient
|
|
234
244
|
self.prevent_sending_due_to_spam = attributes[:'prevent_sending_due_to_spam']
|
235
245
|
end
|
236
246
|
|
247
|
+
if attributes.has_key?(:'repeat_monthly')
|
248
|
+
self.repeat_monthly = attributes[:'repeat_monthly']
|
249
|
+
end
|
250
|
+
|
251
|
+
if attributes.has_key?(:'repeat_weekly')
|
252
|
+
self.repeat_weekly = attributes[:'repeat_weekly']
|
253
|
+
end
|
254
|
+
|
237
255
|
if attributes.has_key?(:'revenue_formatted')
|
238
256
|
self.revenue_formatted = attributes[:'revenue_formatted']
|
239
257
|
end
|
@@ -321,6 +339,8 @@ module UltracartClient
|
|
321
339
|
name == o.name &&
|
322
340
|
open_rate_formatted == o.open_rate_formatted &&
|
323
341
|
prevent_sending_due_to_spam == o.prevent_sending_due_to_spam &&
|
342
|
+
repeat_monthly == o.repeat_monthly &&
|
343
|
+
repeat_weekly == o.repeat_weekly &&
|
324
344
|
revenue_formatted == o.revenue_formatted &&
|
325
345
|
revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
|
326
346
|
scheduled_dts == o.scheduled_dts &&
|
@@ -341,7 +361,7 @@ module UltracartClient
|
|
341
361
|
# Calculates hash code according to all attributes.
|
342
362
|
# @return [Fixnum] Hash code
|
343
363
|
def hash
|
344
|
-
[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
|
364
|
+
[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
|
345
365
|
end
|
346
366
|
|
347
367
|
# Builds the object from hash
|
@@ -241,7 +241,7 @@ module UltracartClient
|
|
241
241
|
# Check to see if the all the properties in the model are valid
|
242
242
|
# @return true if the model is valid
|
243
243
|
def valid?
|
244
|
-
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'])
|
244
|
+
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'])
|
245
245
|
return false unless payment_method_validator.valid?(@payment_method)
|
246
246
|
payment_status_validator = EnumAttributeValidator.new('String', ['Unprocessed', 'Authorized', 'Capture Failed', 'Processed', 'Declined', 'Voided', 'Refunded', 'Skipped'])
|
247
247
|
return false unless payment_status_validator.valid?(@payment_status)
|
@@ -251,7 +251,7 @@ module UltracartClient
|
|
251
251
|
# Custom attribute writer method checking allowed values (enum).
|
252
252
|
# @param [Object] payment_method Object to be assigned
|
253
253
|
def payment_method=(payment_method)
|
254
|
-
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'])
|
254
|
+
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'])
|
255
255
|
unless validator.valid?(payment_method)
|
256
256
|
fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
|
257
257
|
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'
|
@@ -242,6 +239,7 @@ require 'ultracart_api/models/conversation_virtual_agent_budget'
|
|
242
239
|
require 'ultracart_api/models/conversation_virtual_agent_budget_response'
|
243
240
|
require 'ultracart_api/models/conversation_virtual_agent_capabilities'
|
244
241
|
require 'ultracart_api/models/conversation_virtual_agent_capabilities_response'
|
242
|
+
require 'ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department'
|
245
243
|
require 'ultracart_api/models/conversation_webchat_context'
|
246
244
|
require 'ultracart_api/models/conversation_webchat_queue_status'
|
247
245
|
require 'ultracart_api/models/conversation_webchat_queue_status_agent'
|
@@ -323,9 +321,13 @@ require 'ultracart_api/models/coupons_request'
|
|
323
321
|
require 'ultracart_api/models/coupons_response'
|
324
322
|
require 'ultracart_api/models/currency'
|
325
323
|
require 'ultracart_api/models/custom_dashboard'
|
324
|
+
require 'ultracart_api/models/custom_dashboard_execution_parameter'
|
326
325
|
require 'ultracart_api/models/custom_dashboard_page'
|
327
326
|
require 'ultracart_api/models/custom_dashboard_page_report'
|
328
327
|
require 'ultracart_api/models/custom_dashboard_response'
|
328
|
+
require 'ultracart_api/models/custom_dashboard_schedule'
|
329
|
+
require 'ultracart_api/models/custom_dashboard_schedule_response'
|
330
|
+
require 'ultracart_api/models/custom_dashboard_schedules_response'
|
329
331
|
require 'ultracart_api/models/custom_dashboards_response'
|
330
332
|
require 'ultracart_api/models/custom_report'
|
331
333
|
require 'ultracart_api/models/custom_report_account_config'
|
@@ -907,7 +909,6 @@ require 'ultracart_api/models/workflow_users_response'
|
|
907
909
|
require 'ultracart_api/api/affiliate_api'
|
908
910
|
require 'ultracart_api/api/auto_order_api'
|
909
911
|
require 'ultracart_api/api/channel_partner_api'
|
910
|
-
require 'ultracart_api/api/chargeback_api'
|
911
912
|
require 'ultracart_api/api/checkout_api'
|
912
913
|
require 'ultracart_api/api/conversation_api'
|
913
914
|
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: 3.11.
|
4
|
+
version: 3.11.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-
|
11
|
+
date: 2025-08-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -344,10 +344,6 @@ files:
|
|
344
344
|
- docs/ChannelPartnerShipToPreferencesResponse.md
|
345
345
|
- docs/ChannelPartnerShippingEstimate.md
|
346
346
|
- docs/ChannelPartnersResponse.md
|
347
|
-
- docs/ChargebackApi.md
|
348
|
-
- docs/ChargebackDispute.md
|
349
|
-
- docs/ChargebackDisputeResponse.md
|
350
|
-
- docs/ChargebackDisputesResponse.md
|
351
347
|
- docs/CheckoutAllowedCountriesResponse.md
|
352
348
|
- docs/CheckoutApi.md
|
353
349
|
- docs/CheckoutHandoffRequest.md
|
@@ -452,6 +448,7 @@ files:
|
|
452
448
|
- docs/ConversationVirtualAgentBudgetResponse.md
|
453
449
|
- docs/ConversationVirtualAgentCapabilities.md
|
454
450
|
- docs/ConversationVirtualAgentCapabilitiesResponse.md
|
451
|
+
- docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md
|
455
452
|
- docs/ConversationWebchatContext.md
|
456
453
|
- docs/ConversationWebchatQueueStatus.md
|
457
454
|
- docs/ConversationWebchatQueueStatusAgent.md
|
@@ -534,9 +531,13 @@ files:
|
|
534
531
|
- docs/CouponsResponse.md
|
535
532
|
- docs/Currency.md
|
536
533
|
- docs/CustomDashboard.md
|
534
|
+
- docs/CustomDashboardExecutionParameter.md
|
537
535
|
- docs/CustomDashboardPage.md
|
538
536
|
- docs/CustomDashboardPageReport.md
|
539
537
|
- docs/CustomDashboardResponse.md
|
538
|
+
- docs/CustomDashboardSchedule.md
|
539
|
+
- docs/CustomDashboardScheduleResponse.md
|
540
|
+
- docs/CustomDashboardSchedulesResponse.md
|
540
541
|
- docs/CustomDashboardsResponse.md
|
541
542
|
- docs/CustomReport.md
|
542
543
|
- docs/CustomReportAccountConfig.md
|
@@ -1132,7 +1133,6 @@ files:
|
|
1132
1133
|
- lib/ultracart_api/api/affiliate_api.rb
|
1133
1134
|
- lib/ultracart_api/api/auto_order_api.rb
|
1134
1135
|
- lib/ultracart_api/api/channel_partner_api.rb
|
1135
|
-
- lib/ultracart_api/api/chargeback_api.rb
|
1136
1136
|
- lib/ultracart_api/api/checkout_api.rb
|
1137
1137
|
- lib/ultracart_api/api/conversation_api.rb
|
1138
1138
|
- lib/ultracart_api/api/coupon_api.rb
|
@@ -1273,9 +1273,6 @@ files:
|
|
1273
1273
|
- lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb
|
1274
1274
|
- lib/ultracart_api/models/channel_partner_shipping_estimate.rb
|
1275
1275
|
- lib/ultracart_api/models/channel_partners_response.rb
|
1276
|
-
- lib/ultracart_api/models/chargeback_dispute.rb
|
1277
|
-
- lib/ultracart_api/models/chargeback_dispute_response.rb
|
1278
|
-
- lib/ultracart_api/models/chargeback_disputes_response.rb
|
1279
1276
|
- lib/ultracart_api/models/checkout_allowed_countries_response.rb
|
1280
1277
|
- lib/ultracart_api/models/checkout_handoff_request.rb
|
1281
1278
|
- lib/ultracart_api/models/checkout_handoff_response.rb
|
@@ -1378,6 +1375,7 @@ files:
|
|
1378
1375
|
- lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb
|
1379
1376
|
- lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb
|
1380
1377
|
- lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb
|
1378
|
+
- lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb
|
1381
1379
|
- lib/ultracart_api/models/conversation_webchat_context.rb
|
1382
1380
|
- lib/ultracart_api/models/conversation_webchat_queue_status.rb
|
1383
1381
|
- lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb
|
@@ -1459,9 +1457,13 @@ files:
|
|
1459
1457
|
- lib/ultracart_api/models/coupons_response.rb
|
1460
1458
|
- lib/ultracart_api/models/currency.rb
|
1461
1459
|
- lib/ultracart_api/models/custom_dashboard.rb
|
1460
|
+
- lib/ultracart_api/models/custom_dashboard_execution_parameter.rb
|
1462
1461
|
- lib/ultracart_api/models/custom_dashboard_page.rb
|
1463
1462
|
- lib/ultracart_api/models/custom_dashboard_page_report.rb
|
1464
1463
|
- lib/ultracart_api/models/custom_dashboard_response.rb
|
1464
|
+
- lib/ultracart_api/models/custom_dashboard_schedule.rb
|
1465
|
+
- lib/ultracart_api/models/custom_dashboard_schedule_response.rb
|
1466
|
+
- lib/ultracart_api/models/custom_dashboard_schedules_response.rb
|
1465
1467
|
- lib/ultracart_api/models/custom_dashboards_response.rb
|
1466
1468
|
- lib/ultracart_api/models/custom_report.rb
|
1467
1469
|
- lib/ultracart_api/models/custom_report_account_config.rb
|
data/docs/ChargebackApi.md
DELETED
@@ -1,301 +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
|
-
> ChargebackDisputeResponse delete_chargeback(chargeback_dispute_oid)
|
16
|
-
|
17
|
-
Delete a chargeback
|
18
|
-
|
19
|
-
Delete a chargeback on the UltraCart account.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
```ruby
|
23
|
-
# load the gem
|
24
|
-
require 'ultracart_api'
|
25
|
-
|
26
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
27
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
28
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
29
|
-
|
30
|
-
|
31
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
|
32
|
-
|
33
|
-
|
34
|
-
begin
|
35
|
-
#Delete a chargeback
|
36
|
-
result = api_instance.delete_chargeback(chargeback_dispute_oid)
|
37
|
-
p result
|
38
|
-
rescue UltracartClient::ApiError => e
|
39
|
-
puts "Exception when calling ChargebackApi->delete_chargeback: #{e}"
|
40
|
-
end
|
41
|
-
```
|
42
|
-
|
43
|
-
### Parameters
|
44
|
-
|
45
|
-
Name | Type | Description | Notes
|
46
|
-
------------- | ------------- | ------------- | -------------
|
47
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback_dispute_oid to delete. |
|
48
|
-
|
49
|
-
### Return type
|
50
|
-
|
51
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
52
|
-
|
53
|
-
### Authorization
|
54
|
-
|
55
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
56
|
-
|
57
|
-
### HTTP request headers
|
58
|
-
|
59
|
-
- **Content-Type**: application/json
|
60
|
-
- **Accept**: application/json
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
# **get_chargeback_dispute**
|
65
|
-
> ChargebackDisputeResponse get_chargeback_dispute(chargeback_dispute_oid, opts)
|
66
|
-
|
67
|
-
Retrieve a chargeback
|
68
|
-
|
69
|
-
Retrieves a single chargeback using the specified chargeback dispute oid.
|
70
|
-
|
71
|
-
### Example
|
72
|
-
```ruby
|
73
|
-
# load the gem
|
74
|
-
require 'ultracart_api'
|
75
|
-
|
76
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
77
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
78
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
79
|
-
|
80
|
-
|
81
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
|
82
|
-
|
83
|
-
opts = {
|
84
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
85
|
-
}
|
86
|
-
|
87
|
-
begin
|
88
|
-
#Retrieve a chargeback
|
89
|
-
result = api_instance.get_chargeback_dispute(chargeback_dispute_oid, opts)
|
90
|
-
p result
|
91
|
-
rescue UltracartClient::ApiError => e
|
92
|
-
puts "Exception when calling ChargebackApi->get_chargeback_dispute: #{e}"
|
93
|
-
end
|
94
|
-
```
|
95
|
-
|
96
|
-
### Parameters
|
97
|
-
|
98
|
-
Name | Type | Description | Notes
|
99
|
-
------------- | ------------- | ------------- | -------------
|
100
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback dispute oid to retrieve. |
|
101
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
102
|
-
|
103
|
-
### Return type
|
104
|
-
|
105
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
106
|
-
|
107
|
-
### Authorization
|
108
|
-
|
109
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
110
|
-
|
111
|
-
### HTTP request headers
|
112
|
-
|
113
|
-
- **Content-Type**: application/json
|
114
|
-
- **Accept**: application/json
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
# **get_chargeback_disputes**
|
119
|
-
> ChargebackDisputesResponse get_chargeback_disputes(opts)
|
120
|
-
|
121
|
-
Retrieve chargebacks
|
122
|
-
|
123
|
-
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.
|
124
|
-
|
125
|
-
### Example
|
126
|
-
```ruby
|
127
|
-
# load the gem
|
128
|
-
require 'ultracart_api'
|
129
|
-
|
130
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
131
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
132
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
133
|
-
|
134
|
-
|
135
|
-
opts = {
|
136
|
-
order_id: 'order_id_example', # String | Order Id
|
137
|
-
case_number: 'case_number_example', # String | Case number
|
138
|
-
status: 'status_example', # String | Status
|
139
|
-
expiration_dts_start: 'expiration_dts_start_example', # String | Expiration dts start
|
140
|
-
expiration_dts_end: 'expiration_dts_end_example', # String | Expiration dts end
|
141
|
-
chargeback_dts_start: 'chargeback_dts_start_example', # String | Chargeback dts start
|
142
|
-
chargeback_dts_end: 'chargeback_dts_end_example', # String | Chargeback dts end
|
143
|
-
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
144
|
-
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
145
|
-
_since: '_since_example', # String | Fetch chargebacks that have been created/modified since this date/time.
|
146
|
-
_sort: '_sort_example', # String | The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
147
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
148
|
-
}
|
149
|
-
|
150
|
-
begin
|
151
|
-
#Retrieve chargebacks
|
152
|
-
result = api_instance.get_chargeback_disputes(opts)
|
153
|
-
p result
|
154
|
-
rescue UltracartClient::ApiError => e
|
155
|
-
puts "Exception when calling ChargebackApi->get_chargeback_disputes: #{e}"
|
156
|
-
end
|
157
|
-
```
|
158
|
-
|
159
|
-
### Parameters
|
160
|
-
|
161
|
-
Name | Type | Description | Notes
|
162
|
-
------------- | ------------- | ------------- | -------------
|
163
|
-
**order_id** | **String**| Order Id | [optional]
|
164
|
-
**case_number** | **String**| Case number | [optional]
|
165
|
-
**status** | **String**| Status | [optional]
|
166
|
-
**expiration_dts_start** | **String**| Expiration dts start | [optional]
|
167
|
-
**expiration_dts_end** | **String**| Expiration dts end | [optional]
|
168
|
-
**chargeback_dts_start** | **String**| Chargeback dts start | [optional]
|
169
|
-
**chargeback_dts_end** | **String**| Chargeback dts end | [optional]
|
170
|
-
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
171
|
-
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
172
|
-
**_since** | **String**| Fetch chargebacks that have been created/modified since this date/time. | [optional]
|
173
|
-
**_sort** | **String**| The sort order of the chargebacks. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
174
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
175
|
-
|
176
|
-
### Return type
|
177
|
-
|
178
|
-
[**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
|
179
|
-
|
180
|
-
### Authorization
|
181
|
-
|
182
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
183
|
-
|
184
|
-
### HTTP request headers
|
185
|
-
|
186
|
-
- **Content-Type**: application/json
|
187
|
-
- **Accept**: application/json
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
# **insert_chargeback**
|
192
|
-
> ChargebackDisputeResponse insert_chargeback(chargeback, opts)
|
193
|
-
|
194
|
-
Insert a chargeback
|
195
|
-
|
196
|
-
Insert a chargeback on the UltraCart account.
|
197
|
-
|
198
|
-
### Example
|
199
|
-
```ruby
|
200
|
-
# load the gem
|
201
|
-
require 'ultracart_api'
|
202
|
-
|
203
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
204
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
205
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
206
|
-
|
207
|
-
|
208
|
-
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
|
209
|
-
|
210
|
-
opts = {
|
211
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
212
|
-
}
|
213
|
-
|
214
|
-
begin
|
215
|
-
#Insert a chargeback
|
216
|
-
result = api_instance.insert_chargeback(chargeback, opts)
|
217
|
-
p result
|
218
|
-
rescue UltracartClient::ApiError => e
|
219
|
-
puts "Exception when calling ChargebackApi->insert_chargeback: #{e}"
|
220
|
-
end
|
221
|
-
```
|
222
|
-
|
223
|
-
### Parameters
|
224
|
-
|
225
|
-
Name | Type | Description | Notes
|
226
|
-
------------- | ------------- | ------------- | -------------
|
227
|
-
**chargeback** | [**ChargebackDispute**](ChargebackDispute.md)| Chargeback to insert |
|
228
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
229
|
-
|
230
|
-
### Return type
|
231
|
-
|
232
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
233
|
-
|
234
|
-
### Authorization
|
235
|
-
|
236
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
237
|
-
|
238
|
-
### HTTP request headers
|
239
|
-
|
240
|
-
- **Content-Type**: application/json; charset=UTF-8
|
241
|
-
- **Accept**: application/json
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
# **update_chargeback**
|
246
|
-
> ChargebackDisputeResponse update_chargeback(chargeback, chargeback_dispute_oid, opts)
|
247
|
-
|
248
|
-
Update a chargeback
|
249
|
-
|
250
|
-
Update a chargeback on the UltraCart account.
|
251
|
-
|
252
|
-
### Example
|
253
|
-
```ruby
|
254
|
-
# load the gem
|
255
|
-
require 'ultracart_api'
|
256
|
-
|
257
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
258
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
259
|
-
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
260
|
-
|
261
|
-
|
262
|
-
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
|
263
|
-
|
264
|
-
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to update.
|
265
|
-
|
266
|
-
opts = {
|
267
|
-
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
268
|
-
}
|
269
|
-
|
270
|
-
begin
|
271
|
-
#Update a chargeback
|
272
|
-
result = api_instance.update_chargeback(chargeback, chargeback_dispute_oid, opts)
|
273
|
-
p result
|
274
|
-
rescue UltracartClient::ApiError => e
|
275
|
-
puts "Exception when calling ChargebackApi->update_chargeback: #{e}"
|
276
|
-
end
|
277
|
-
```
|
278
|
-
|
279
|
-
### Parameters
|
280
|
-
|
281
|
-
Name | Type | Description | Notes
|
282
|
-
------------- | ------------- | ------------- | -------------
|
283
|
-
**chargeback** | [**ChargebackDispute**](ChargebackDispute.md)| Chargeback to update |
|
284
|
-
**chargeback_dispute_oid** | **Integer**| The chargeback_dispute_oid to update. |
|
285
|
-
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
286
|
-
|
287
|
-
### Return type
|
288
|
-
|
289
|
-
[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
|
290
|
-
|
291
|
-
### Authorization
|
292
|
-
|
293
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
294
|
-
|
295
|
-
### HTTP request headers
|
296
|
-
|
297
|
-
- **Content-Type**: application/json; charset=UTF-8
|
298
|
-
- **Accept**: application/json
|
299
|
-
|
300
|
-
|
301
|
-
|
data/docs/ChargebackDispute.md
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
# UltracartClient::ChargebackDispute
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**account_number** | **String** | Account number | [optional]
|
7
|
-
**adjustment_request_text** | **String** | Adjustment request text | [optional]
|
8
|
-
**amount** | **Float** | Amount | [optional]
|
9
|
-
**auth_code** | **String** | Auth code | [optional]
|
10
|
-
**case_number** | **String** | Case number | [optional]
|
11
|
-
**chargeback_dispute_oid** | **Integer** | Chargeback Dispute Oid | [optional]
|
12
|
-
**chargeback_dts** | **String** | Chargeback dts | [optional]
|
13
|
-
**currency** | **String** | Currency | [optional]
|
14
|
-
**customer_care_notes** | **String** | Customer care notes | [optional]
|
15
|
-
**encryption_key** | **String** | Encryption key | [optional]
|
16
|
-
**expiration_dts** | **String** | Expiration Dts | [optional]
|
17
|
-
**fax_failure_reason** | **String** | Fax failure reason | [optional]
|
18
|
-
**fax_number** | **String** | Fax number | [optional]
|
19
|
-
**fax_transaction_id** | **Integer** | Fax transaction id | [optional]
|
20
|
-
**icsid** | **String** | icsid | [optional]
|
21
|
-
**merchant_account_profile_oid** | **Integer** | Merchant account profile oid | [optional]
|
22
|
-
**order** | [**Order**](Order.md) | | [optional]
|
23
|
-
**order_id** | **String** | Order Id | [optional]
|
24
|
-
**partial_card_number** | **String** | Partial card number | [optional]
|
25
|
-
**pdf_file_oid** | **String** | PDF file oid | [optional]
|
26
|
-
**reason_code** | **String** | Reason code | [optional]
|
27
|
-
**status** | **String** | Status | [optional]
|
28
|
-
**website_url** | **String** | Website URL | [optional]
|
29
|
-
|
30
|
-
|