ultracart_api 3.3.2 → 3.4.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +61 -4
- data/docs/ConfigurationApi.md +756 -0
- data/docs/DelayAutoOrdersResponse.md +12 -0
- data/docs/IntegrationLogApi.md +51 -0
- data/docs/IntegrationLogSummary.md +16 -0
- data/docs/IntegrationLogSummaryQueryRequest.md +9 -0
- data/docs/IntegrationLogSummaryQueryResponse.md +12 -0
- data/docs/OrderChannelPartner.md +1 -0
- data/docs/PaymentsConfiguration.md +23 -0
- data/docs/PaymentsConfigurationAffirm.md +15 -0
- data/docs/PaymentsConfigurationAmazon.md +15 -0
- data/docs/PaymentsConfigurationCOD.md +13 -0
- data/docs/PaymentsConfigurationCash.md +9 -0
- data/docs/PaymentsConfigurationCheck.md +25 -0
- data/docs/PaymentsConfigurationCreditCard.md +16 -0
- data/docs/PaymentsConfigurationLoanHero.md +12 -0
- data/docs/PaymentsConfigurationPayPal.md +36 -0
- data/docs/PaymentsConfigurationPurchaseOrder.md +11 -0
- data/docs/PaymentsConfigurationQuoteRequest.md +10 -0
- data/docs/PaymentsConfigurationResponse.md +12 -0
- data/docs/PaymentsConfigurationRestrictions.md +19 -0
- data/docs/PaymentsConfigurationSezzle.md +15 -0
- data/docs/PaymentsConfigurationWePay.md +35 -0
- data/docs/PaymentsConfigurationWireTransfer.md +18 -0
- data/docs/PaymentsThemeTransactionType.md +10 -0
- data/docs/PaymentsWepayEnroll.md +22 -0
- data/docs/RotatingTransactionGateway.md +50 -0
- data/docs/RotatingTransactionGatewayResponse.md +12 -0
- data/docs/RotatingTransactionGatewaysResponse.md +12 -0
- data/docs/RtgCurrency.md +10 -0
- data/docs/RtgDayOfMonthRestriction.md +9 -0
- data/docs/RtgDayOfWeekRestriction.md +10 -0
- data/docs/RtgSummaryGateway.md +24 -0
- data/docs/RtgSummaryResponse.md +14 -0
- data/docs/RtgThemeRestriction.md +10 -0
- data/docs/StripeConnectResponse.md +12 -0
- data/docs/TransactionGateway.md +71 -0
- data/docs/TransactionGatewaysRequest.md +10 -0
- data/docs/TransactionGatewaysResponse.md +12 -0
- data/lib/ultracart_api.rb +36 -0
- data/lib/ultracart_api/api/configuration_api.rb +843 -0
- data/lib/ultracart_api/api/integration_log_api.rb +55 -0
- data/lib/ultracart_api/models/delay_auto_orders_response.rb +221 -0
- data/lib/ultracart_api/models/integration_log_summary.rb +256 -0
- data/lib/ultracart_api/models/integration_log_summary_query_request.rb +195 -0
- data/lib/ultracart_api/models/integration_log_summary_query_response.rb +223 -0
- data/lib/ultracart_api/models/order_channel_partner.rb +11 -1
- data/lib/ultracart_api/models/payments_configuration.rb +319 -0
- data/lib/ultracart_api/models/payments_configuration_affirm.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_amazon.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_cash.rb +193 -0
- data/lib/ultracart_api/models/payments_configuration_check.rb +337 -0
- data/lib/ultracart_api/models/payments_configuration_cod.rb +229 -0
- data/lib/ultracart_api/models/payments_configuration_credit_card.rb +256 -0
- data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +220 -0
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +436 -0
- data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +211 -0
- data/lib/ultracart_api/models/payments_configuration_quote_request.rb +202 -0
- data/lib/ultracart_api/models/payments_configuration_response.rb +221 -0
- data/lib/ultracart_api/models/payments_configuration_restrictions.rb +283 -0
- data/lib/ultracart_api/models/payments_configuration_sezzle.rb +247 -0
- data/lib/ultracart_api/models/payments_configuration_we_pay.rb +427 -0
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +274 -0
- data/lib/ultracart_api/models/payments_theme_transaction_type.rb +239 -0
- data/lib/ultracart_api/models/payments_wepay_enroll.rb +310 -0
- data/lib/ultracart_api/models/rotating_transaction_gateway.rb +665 -0
- data/lib/ultracart_api/models/rotating_transaction_gateway_response.rb +221 -0
- data/lib/ultracart_api/models/rotating_transaction_gateways_response.rb +223 -0
- data/lib/ultracart_api/models/rtg_currency.rb +205 -0
- data/lib/ultracart_api/models/rtg_day_of_month_restriction.rb +195 -0
- data/lib/ultracart_api/models/rtg_day_of_week_restriction.rb +205 -0
- data/lib/ultracart_api/models/rtg_summary_gateway.rb +329 -0
- data/lib/ultracart_api/models/rtg_summary_response.rb +240 -0
- data/lib/ultracart_api/models/rtg_theme_restriction.rb +239 -0
- data/lib/ultracart_api/models/stripe_connect_response.rb +221 -0
- data/lib/ultracart_api/models/transaction_gateway.rb +823 -0
- data/lib/ultracart_api/models/transaction_gateways_request.rb +242 -0
- data/lib/ultracart_api/models/transaction_gateways_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +74 -2
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::PaymentsThemeTransactionType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | External human readable identifier for a theme | [optional]
|
7
|
+
**credit_card_transaction_type** | **String** | The credit card transaction type for this theme | [optional]
|
8
|
+
**screen_branding_theme_oid** | **Integer** | Internal identifier for a theme | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::PaymentsWepayEnroll
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**address1** | **String** | | [optional]
|
7
|
+
**address2** | **String** | | [optional]
|
8
|
+
**canada_accept_debit_cards** | **BOOLEAN** | | [optional]
|
9
|
+
**city** | **String** | | [optional]
|
10
|
+
**company** | **String** | | [optional]
|
11
|
+
**company_description** | **String** | | [optional]
|
12
|
+
**country** | **String** | | [optional]
|
13
|
+
**expected_revenue** | **String** | | [optional]
|
14
|
+
**industry** | **String** | | [optional]
|
15
|
+
**owner_email** | **String** | | [optional]
|
16
|
+
**owner_name** | **String** | | [optional]
|
17
|
+
**owner_phone** | **String** | | [optional]
|
18
|
+
**state** | **String** | | [optional]
|
19
|
+
**webiste_url** | **String** | | [optional]
|
20
|
+
**zip** | **String** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**additional_native_currency_codes** | [**Array<RtgCurrency>**](RtgCurrency.md) | An array of all currencies known to the UltraCart system and a boolean indicating whether this gateway supports that currency. | [optional]
|
7
|
+
**auto_order_cancel_unless_response_name** | **String** | Advanced feature for canceling an auto order unless the transaction gateway response contains a field with this name. If specified, this field must exist and the value must equal a value in the auto_order_cancel_unless_response_values array | [optional]
|
8
|
+
**auto_order_cancel_unless_response_values** | **Array<String>** | Advanced feature for canceling an auto order unless the transaction gateway response contains a field with the name specified in auto_order_cancel_unless_response_name. If specified, this field must exist and the value must equal a value in this array. If nothing matches, the auto order is canceled. | [optional]
|
9
|
+
**base_currency_code** | **String** | The base currency code for your gateway. For example, USD. | [optional]
|
10
|
+
**cascade_code** | **String** | Optional field specifying a different rotating gateway to use if this gateway fails to process the transaction. | [optional]
|
11
|
+
**cascade_codes** | **Array<String>** | A list of other rotating transaction gateways that can be used as a lookup to assign actions based on failures of this gateway | [optional]
|
12
|
+
**cascade_daily_auto_order_code** | **String** | The code for the next rotating gateway that should be used when this gateway reaches a daily limit | [optional]
|
13
|
+
**charge_appears_on_statement_as** | **String** | Optional field providing an alternate Charge Appears As value for this rotating gateway | [optional]
|
14
|
+
**code** | **String** | A human friendly short code used to recognize and differentiate this rotating gateway with other rotating gateways | [optional]
|
15
|
+
**current_daily** | **Float** | The current daily dollar amount this gateway has processed. Providing this will allow UltraCart to track the monthly amount going forward. | [optional]
|
16
|
+
**current_daily_auto_order** | **Float** | The current daily dollar amount of auto orders (recurring) this gateway has processed. Providing this will allow UltraCart to track the monthly amount going forward. | [optional]
|
17
|
+
**current_monthly** | **Float** | The current monthly dollar amount this gateway has processed. Providing this will allow UltraCart to track the monthly amount going forward. | [optional]
|
18
|
+
**customer_service_email** | **String** | The customer service email address for this gateway | [optional]
|
19
|
+
**customer_service_phone** | **String** | The customer service phone number for this gateway | [optional]
|
20
|
+
**day_of_month_restrictions** | [**Array<RtgDayOfMonthRestriction>**](RtgDayOfMonthRestriction.md) | Array containing all 31 (possible) days and any optional restrictions for one or more days. | [optional]
|
21
|
+
**day_of_week_restrictions** | [**Array<RtgDayOfWeekRestriction>**](RtgDayOfWeekRestriction.md) | Array containing all seven days of the week and any optional restrictions for one or more days | [optional]
|
22
|
+
**deactivate_after_failures** | **Integer** | If non-zero, this gateway will be deactivated after reaching this amount of consecutive failures. | [optional]
|
23
|
+
**end_date** | **String** | Optional field to specify an absolute date when this gateway should stop accepting transactions | [optional]
|
24
|
+
**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | An array of all transaction gateways, not just the one currently configured for this rotating gateway. This allows for easy switching to another gateway. The enabled property on the transaction gateway indicates which one is actually being used. | [optional]
|
25
|
+
**maximum_daily** | **Float** | The maximum daily dollar amount this gateway may process | [optional]
|
26
|
+
**maximum_daily_auto_order** | **Float** | The maximum daily dollar amount of auto orders (recurring) this gateway may process | [optional]
|
27
|
+
**maximum_monthly** | **Float** | The maximum monthly dollar amount this gateway may process. | [optional]
|
28
|
+
**next_daily_auto_order_reset** | **String** | The date and time when this gateway daily limit for auto orders will reset | [optional]
|
29
|
+
**next_daily_reset** | **String** | The date and time when this gateway daily limit will reset | [optional]
|
30
|
+
**next_monthly_reset** | **String** | The date and time when this gateway monthly limit will reset | [optional]
|
31
|
+
**order_total** | **Float** | This optional field is combined with order_total_comparison to determine if an order should be processed thorugh this gateway. | [optional]
|
32
|
+
**order_total_comparison** | **String** | The math operator used to determine if the order total is allowed to process through this gateway. | [optional]
|
33
|
+
**rebill_auto_orders_against_this_rtg_code** | **String** | If specified auto orders (rebills) are routed to this rotating gateway. This may be needed because rebills lack a credit card cvv. | [optional]
|
34
|
+
**reserve_days** | **Integer** | The number of days that your gateway holds any reserves. This aids in profitability reporting. | [optional]
|
35
|
+
**reserve_percentage** | **Float** | The percentage of an order which your gateway is holding in reserve. This aids in profitability reporting. | [optional]
|
36
|
+
**reserve_refunded** | **BOOLEAN** | If true, reserves are refunded when an order is refunded. This aids in profitability reporting. | [optional]
|
37
|
+
**reserves_released_through** | **String** | An optional date specifying the date up to which your gateway has released all reserve funds. This aids in profitability reporting. | [optional]
|
38
|
+
**rotating_transaction_gateway_oid** | **Integer** | Internal identifier used to store and retrieve this gateway information | [optional]
|
39
|
+
**selected_gateway_name** | **String** | The name of the currently selected transaction gateway used by this rotating gateway | [optional]
|
40
|
+
**show_cascade_codes** | **BOOLEAN** | A boolean used by the builtin UltraCart UI to determine if cascading rtg codes should be shown | [optional]
|
41
|
+
**show_merchant_account_profiles** | **BOOLEAN** | A flag to help the UltraCart UI to know whether to show merchant account profiles or not. | [optional]
|
42
|
+
**start_date** | **String** | Optional field to specify an absolute date when this gateway should begin accepting transactions | [optional]
|
43
|
+
**status** | **String** | A field used to take a gateway offline without removing/deleting the configuration. Inactive marks the gateway as completely unusable. Standby takes the gateway offline and will not be used unless all other active gateways fail. | [optional]
|
44
|
+
**theme_restrictions** | [**Array<RtgThemeRestriction>**](RtgThemeRestriction.md) | Optional restrictions by theme/storefront | [optional]
|
45
|
+
**traffic_percentage** | **Float** | Required field between 0 and 1 that dictates the percentage of traffic that should flow through this gateway | [optional]
|
46
|
+
**trial_daily_amount** | **Integer** | If specified, limits the total daily dollar amount of trial orders | [optional]
|
47
|
+
**trial_daily_limit** | **Integer** | If specified, limits the total month count of trial orders | [optional]
|
48
|
+
**trial_monthly_limit** | **Integer** | If specified, limits the total month dollar amount of trial orders | [optional]
|
49
|
+
|
50
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGatewayResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**rotating_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::RotatingTransactionGatewaysResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**rotating_gateways** | [**Array<RotatingTransactionGateway>**](RotatingTransactionGateway.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/RtgCurrency.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgCurrency
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**currency_code** | **String** | Standard three letter currency code, for example USD | [optional]
|
7
|
+
**description** | **String** | Human friendly description of currency | [optional]
|
8
|
+
**selected** | **BOOLEAN** | true if this rotating gateway supports this currency | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::RtgDayOfMonthRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**day_of_month** | **Integer** | The day of the month. 1 equals the first day of the month, 31 is the last possible value. | [optional]
|
7
|
+
**selected** | **BOOLEAN** | True if this rotating gateway is allowed to operate on this day of month. If no days are selected, all days are allowed. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgDayOfWeekRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**abbreviation** | **String** | Human readable day of week abbreviation | [optional]
|
7
|
+
**day_of_week** | **Integer** | 1=Sun,2=Mon,3=Tue,4=Wed,5=Thu,6=Fri,7=Sat | [optional]
|
8
|
+
**selected** | **BOOLEAN** | True if this rotating gateway is allowed to operate on this day of week. If no days are selected, all days are allowed. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# UltracartClient::RtgSummaryGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cascade_code** | **String** | | [optional]
|
7
|
+
**code** | **String** | | [optional]
|
8
|
+
**delay_auto_orders** | **String** | | [optional]
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**reserve_percentage** | **Float** | | [optional]
|
11
|
+
**reserves_released_through** | **String** | An optional date specifying the date up to which your gateway has released all reserve funds. This aids in profitability reporting. | [optional]
|
12
|
+
**rotating_transaction_gateway_oid** | **Integer** | | [optional]
|
13
|
+
**show_ultracart_payments_verification** | **BOOLEAN** | | [optional]
|
14
|
+
**show_ultracart_payments_verified** | **BOOLEAN** | | [optional]
|
15
|
+
**status** | **String** | | [optional]
|
16
|
+
**supports_auth** | **String** | | [optional]
|
17
|
+
**supports_refund** | **String** | | [optional]
|
18
|
+
**third_party** | **String** | | [optional]
|
19
|
+
**traffic_percentage** | **Float** | | [optional]
|
20
|
+
**warning** | **String** | | [optional]
|
21
|
+
**wepay_account_update_uri** | **String** | | [optional]
|
22
|
+
**wepay_console_hostname** | **String** | | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::RtgSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**gateways** | [**Array<RtgSummaryGateway>**](RtgSummaryGateway.md) | | [optional]
|
7
|
+
**info_message** | **String** | | [optional]
|
8
|
+
**migration_rtg_code** | **String** | | [optional]
|
9
|
+
**migration_single_gateway_name** | **String** | | [optional]
|
10
|
+
**show_delay_auto_orders** | **BOOLEAN** | | [optional]
|
11
|
+
**show_migration** | **BOOLEAN** | | [optional]
|
12
|
+
**warning** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::RtgThemeRestriction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**restriction** | **String** | Any restriction for this theme | [optional]
|
7
|
+
**storefront_host_name** | **String** | The server name for this theme. This will not be populated for legacy (ancient) themes | [optional]
|
8
|
+
**theme_code** | **String** | Human friendly short code for this theme | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::StripeConnectResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**connect_url** | **String** | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# UltracartClient::TransactionGateway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**arbitrary_html** | **String** | Additional html to display for this transaction gateway. This html will include instructions and connection links | [optional]
|
7
|
+
**comment** | **String** | Additional comments | [optional]
|
8
|
+
**credit_card_capable** | **BOOLEAN** | True if this gateway supports credit cards | [optional]
|
9
|
+
**echeck_capable** | **BOOLEAN** | True if this gateway supports eChecks | [optional]
|
10
|
+
**echeck_supported** | **String** | True if this gateway supports eChecks | [optional]
|
11
|
+
**enabled** | **BOOLEAN** | True if this transaction gateway is the currently active gateway. | [optional]
|
12
|
+
**gateway_cert_pem** | **String** | Cryptographic public certificate allowing UltraCart to communicate securely with this gateway. | [optional]
|
13
|
+
**gateway_cert_pem_label** | **String** | The label for the gateway certificate pem. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
14
|
+
**gateway_email** | **String** | Gateway Email | [optional]
|
15
|
+
**gateway_email_label** | **String** | The label for the gateway email. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
16
|
+
**gateway_environment** | **String** | Gateway Environment to indicate sandbox versus production environments | [optional]
|
17
|
+
**gateway_environment_label** | **String** | The label for the gateway environment. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
18
|
+
**gateway_environments** | **Array<String>** | Used to populate drop down lists for the gateway environment. Varies by gateway. | [optional]
|
19
|
+
**gateway_header_back_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
20
|
+
**gateway_header_border_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
21
|
+
**gateway_header_image_url** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
22
|
+
**gateway_key** | **String** | Gateway Key | [optional]
|
23
|
+
**gateway_key_label** | **String** | The label for the gateway key. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
24
|
+
**gateway_key_pem** | **String** | Cryptographic private key allowing UltraCart to communicate securely with this gateway. | [optional]
|
25
|
+
**gateway_key_pem_label** | **String** | The label for the gateway key pem. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
26
|
+
**gateway_landing_page** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
27
|
+
**gateway_merchant_id** | **String** | Gateway Merchant ID | [optional]
|
28
|
+
**gateway_merchant_id_label** | **String** | The label for the gateway merchant id. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
29
|
+
**gateway_mode** | **String** | Gateway Mode | [optional]
|
30
|
+
**gateway_mode_label** | **String** | The label for the gateway mode. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
31
|
+
**gateway_modes** | **Array<String>** | Used to populate drop down lists for gateway modes | [optional]
|
32
|
+
**gateway_page_style** | **String** | Gateway Page Style | [optional]
|
33
|
+
**gateway_page_style_label** | **String** | Gateway page style label | [optional]
|
34
|
+
**gateway_page_styles** | **Array<String>** | Used to populate drop down lists for gateway page style | [optional]
|
35
|
+
**gateway_partner** | **String** | Gateway Partner | [optional]
|
36
|
+
**gateway_partner_label** | **String** | The label for the gateway partner. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
37
|
+
**gateway_password** | **String** | Gateway Password | [optional]
|
38
|
+
**gateway_password_label** | **String** | The label for the gateway password. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
39
|
+
**gateway_payflow_color** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
40
|
+
**gateway_private_key_password** | **String** | Gateway private key password | [optional]
|
41
|
+
**gateway_private_key_password_label** | **String** | The label for the gateway private key password. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
42
|
+
**gateway_solution_type** | **String** | Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS | [optional]
|
43
|
+
**gateway_solution_type_label** | **String** | The label for the gateway solution type. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
44
|
+
**gateway_solution_types** | **Array<String>** | Used to populate drop down lists for gateway solution types | [optional]
|
45
|
+
**gateway_url** | **String** | Gateway URL | [optional]
|
46
|
+
**gateway_url_label** | **String** | The label for the gateway url. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
47
|
+
**gateway_username** | **String** | Gateway Username | [optional]
|
48
|
+
**gateway_username_label** | **String** | The label for the gateway username. The actual value stored may vary by gateway, so the label will vary too. | [optional]
|
49
|
+
**merchant_account_profile_amex** | **String** | If a merchant has multiple card processing accounts, this is the one to use for American Express cards. | [optional]
|
50
|
+
**merchant_account_profile_diners_club** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Diners Club cards. | [optional]
|
51
|
+
**merchant_account_profile_discover** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Discover cards. | [optional]
|
52
|
+
**merchant_account_profile_jcb** | **String** | If a merchant has multiple card processing accounts, this is the one to use for JCB cards. | [optional]
|
53
|
+
**merchant_account_profile_mastercard** | **String** | If a merchant has multiple card processing accounts, this is the one to use for MasterCard cards. | [optional]
|
54
|
+
**merchant_account_profile_visa** | **String** | If a merchant has multiple card processing accounts, this is the one to use for VISA cards. | [optional]
|
55
|
+
**merchant_id** | **String** | UltraCart Merchant ID | [optional]
|
56
|
+
**multi_currency_details** | **BOOLEAN** | True if this gateway provides details for multiple currency transactions | [optional]
|
57
|
+
**name** | **String** | Name of this transaction gateway | [optional]
|
58
|
+
**refund_supported** | **BOOLEAN** | True if this gateway supports refunds | [optional]
|
59
|
+
**require_echeck_tax_id_or_drivers_license** | **BOOLEAN** | If true, e-Check transaction will require either a Tax ID or a Driver License | [optional]
|
60
|
+
**support_vbv_3ds** | **BOOLEAN** | True if this gateway supported Verified-by-VISA 3D Secure | [optional]
|
61
|
+
**supports_amex** | **BOOLEAN** | If true, this gateway will attempt to process American Express transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
62
|
+
**supports_diners_club** | **BOOLEAN** | If true, this gateway will attempt to process Diners Club transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
63
|
+
**supports_discover** | **BOOLEAN** | If true, this gateway will attempt to process Discover transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
64
|
+
**supports_echeck** | **BOOLEAN** | If true, this gateway will attempt to process e-Check transactions. If false, the customer will not be allowed to use e-Checks. | [optional]
|
65
|
+
**supports_electronic_gift_card** | **BOOLEAN** | if true, this gateway will attempt to process electronic gift cards. | [optional]
|
66
|
+
**supports_jcb** | **BOOLEAN** | If true, this gateway will attempt to process JCB transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
67
|
+
**supports_mastercard** | **BOOLEAN** | If true, this gateway will attempt to process MasterCard transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
68
|
+
**supports_visa** | **BOOLEAN** | If true, this gateway will attempt to process VISA transactions. If false, the customer will not be allowed to use this type of Credit Card. | [optional]
|
69
|
+
**third_party** | **BOOLEAN** | True if this gateway supports third parties | [optional]
|
70
|
+
|
71
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::TransactionGatewaysRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**default_credit_card_transaction_type** | **String** | The default transaction type for this merchant account | [optional]
|
7
|
+
**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | | [optional]
|
8
|
+
**theme_credit_card_transaction_types** | [**Array<PaymentsThemeTransactionType>**](PaymentsThemeTransactionType.md) | A list of the storefronts and themes for this merchant account and what type of transaction should be attempted | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::TransactionGatewaysResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/lib/ultracart_api.rb
CHANGED
@@ -206,6 +206,7 @@ require 'ultracart_api/models/customer_tag'
|
|
206
206
|
require 'ultracart_api/models/customer_tax_codes'
|
207
207
|
require 'ultracart_api/models/customers_response'
|
208
208
|
require 'ultracart_api/models/data_tables_server_side_response'
|
209
|
+
require 'ultracart_api/models/delay_auto_orders_response'
|
209
210
|
require 'ultracart_api/models/distance'
|
210
211
|
require 'ultracart_api/models/distribution_center'
|
211
212
|
require 'ultracart_api/models/distribution_centers_response'
|
@@ -334,6 +335,9 @@ require 'ultracart_api/models/integration_log_query_filter_values'
|
|
334
335
|
require 'ultracart_api/models/integration_log_query_request'
|
335
336
|
require 'ultracart_api/models/integration_log_query_response'
|
336
337
|
require 'ultracart_api/models/integration_log_response'
|
338
|
+
require 'ultracart_api/models/integration_log_summary'
|
339
|
+
require 'ultracart_api/models/integration_log_summary_query_request'
|
340
|
+
require 'ultracart_api/models/integration_log_summary_query_response'
|
337
341
|
require 'ultracart_api/models/item'
|
338
342
|
require 'ultracart_api/models/item_accounting'
|
339
343
|
require 'ultracart_api/models/item_amember'
|
@@ -484,6 +488,24 @@ require 'ultracart_api/models/order_token_response'
|
|
484
488
|
require 'ultracart_api/models/order_tracking_number_detail'
|
485
489
|
require 'ultracart_api/models/order_tracking_number_details'
|
486
490
|
require 'ultracart_api/models/orders_response'
|
491
|
+
require 'ultracart_api/models/payments_configuration'
|
492
|
+
require 'ultracart_api/models/payments_configuration_affirm'
|
493
|
+
require 'ultracart_api/models/payments_configuration_amazon'
|
494
|
+
require 'ultracart_api/models/payments_configuration_cod'
|
495
|
+
require 'ultracart_api/models/payments_configuration_cash'
|
496
|
+
require 'ultracart_api/models/payments_configuration_check'
|
497
|
+
require 'ultracart_api/models/payments_configuration_credit_card'
|
498
|
+
require 'ultracart_api/models/payments_configuration_loan_hero'
|
499
|
+
require 'ultracart_api/models/payments_configuration_pay_pal'
|
500
|
+
require 'ultracart_api/models/payments_configuration_purchase_order'
|
501
|
+
require 'ultracart_api/models/payments_configuration_quote_request'
|
502
|
+
require 'ultracart_api/models/payments_configuration_response'
|
503
|
+
require 'ultracart_api/models/payments_configuration_restrictions'
|
504
|
+
require 'ultracart_api/models/payments_configuration_sezzle'
|
505
|
+
require 'ultracart_api/models/payments_configuration_we_pay'
|
506
|
+
require 'ultracart_api/models/payments_configuration_wire_transfer'
|
507
|
+
require 'ultracart_api/models/payments_theme_transaction_type'
|
508
|
+
require 'ultracart_api/models/payments_wepay_enroll'
|
487
509
|
require 'ultracart_api/models/permission'
|
488
510
|
require 'ultracart_api/models/pricing_tier'
|
489
511
|
require 'ultracart_api/models/pricing_tier_notification'
|
@@ -494,6 +516,15 @@ require 'ultracart_api/models/register_affiliate_click_request'
|
|
494
516
|
require 'ultracart_api/models/register_affiliate_click_response'
|
495
517
|
require 'ultracart_api/models/response_metadata'
|
496
518
|
require 'ultracart_api/models/result_set'
|
519
|
+
require 'ultracart_api/models/rotating_transaction_gateway'
|
520
|
+
require 'ultracart_api/models/rotating_transaction_gateway_response'
|
521
|
+
require 'ultracart_api/models/rotating_transaction_gateways_response'
|
522
|
+
require 'ultracart_api/models/rtg_currency'
|
523
|
+
require 'ultracart_api/models/rtg_day_of_month_restriction'
|
524
|
+
require 'ultracart_api/models/rtg_day_of_week_restriction'
|
525
|
+
require 'ultracart_api/models/rtg_summary_gateway'
|
526
|
+
require 'ultracart_api/models/rtg_summary_response'
|
527
|
+
require 'ultracart_api/models/rtg_theme_restriction'
|
497
528
|
require 'ultracart_api/models/screen_recording'
|
498
529
|
require 'ultracart_api/models/screen_recording_ad_platform'
|
499
530
|
require 'ultracart_api/models/screen_recording_filter'
|
@@ -552,6 +583,7 @@ require 'ultracart_api/models/single_sign_on_token_response'
|
|
552
583
|
require 'ultracart_api/models/sovos_config'
|
553
584
|
require 'ultracart_api/models/state_province'
|
554
585
|
require 'ultracart_api/models/step_waiting'
|
586
|
+
require 'ultracart_api/models/stripe_connect_response'
|
555
587
|
require 'ultracart_api/models/tax_city'
|
556
588
|
require 'ultracart_api/models/tax_country'
|
557
589
|
require 'ultracart_api/models/tax_country_code'
|
@@ -581,6 +613,9 @@ require 'ultracart_api/models/transaction_email'
|
|
581
613
|
require 'ultracart_api/models/transaction_email_list_response'
|
582
614
|
require 'ultracart_api/models/transaction_email_option'
|
583
615
|
require 'ultracart_api/models/transaction_email_response'
|
616
|
+
require 'ultracart_api/models/transaction_gateway'
|
617
|
+
require 'ultracart_api/models/transaction_gateways_request'
|
618
|
+
require 'ultracart_api/models/transaction_gateways_response'
|
584
619
|
require 'ultracart_api/models/ultra_cart_config'
|
585
620
|
require 'ultracart_api/models/upload_coupon_codes_request'
|
586
621
|
require 'ultracart_api/models/upload_coupon_codes_response'
|
@@ -610,6 +645,7 @@ require 'ultracart_api/api/affiliate_api'
|
|
610
645
|
require 'ultracart_api/api/auto_order_api'
|
611
646
|
require 'ultracart_api/api/chargeback_api'
|
612
647
|
require 'ultracart_api/api/checkout_api'
|
648
|
+
require 'ultracart_api/api/configuration_api'
|
613
649
|
require 'ultracart_api/api/coupon_api'
|
614
650
|
require 'ultracart_api/api/customer_api'
|
615
651
|
require 'ultracart_api/api/fulfillment_api'
|
@@ -0,0 +1,843 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class ConfigurationApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
|
24
|
+
api_config = Configuration.new
|
25
|
+
api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
|
26
|
+
api_config.api_version = '2017-03-01'
|
27
|
+
api_config.verify_ssl = verify_ssl
|
28
|
+
|
29
|
+
api_client = ApiClient.new(api_config)
|
30
|
+
api_client.config.debugging = debugging
|
31
|
+
|
32
|
+
UltracartClient::ConfigurationApi.new(api_client)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Delay auto order processing for a day for this rotating transaction gateway
|
36
|
+
# Delay auto order processing for a day for this rotating transaction gateway
|
37
|
+
# @param rtg_oid The rtg_oid to delay.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [DelayAutoOrdersResponse]
|
40
|
+
def delay_auto_orders(rtg_oid, opts = {})
|
41
|
+
data, _status_code, _headers = delay_auto_orders_with_http_info(rtg_oid, opts)
|
42
|
+
data
|
43
|
+
end
|
44
|
+
|
45
|
+
# Delay auto order processing for a day for this rotating transaction gateway
|
46
|
+
# Delay auto order processing for a day for this rotating transaction gateway
|
47
|
+
# @param rtg_oid The rtg_oid to delay.
|
48
|
+
# @param [Hash] opts the optional parameters
|
49
|
+
# @return [Array<(DelayAutoOrdersResponse, Fixnum, Hash)>] DelayAutoOrdersResponse data, response status code and response headers
|
50
|
+
def delay_auto_orders_with_http_info(rtg_oid, opts = {})
|
51
|
+
if @api_client.config.debugging
|
52
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.delay_auto_orders ...'
|
53
|
+
end
|
54
|
+
# verify the required parameter 'rtg_oid' is set
|
55
|
+
if @api_client.config.client_side_validation && rtg_oid.nil?
|
56
|
+
fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.delay_auto_orders"
|
57
|
+
end
|
58
|
+
# resource path
|
59
|
+
local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)
|
60
|
+
|
61
|
+
# query parameters
|
62
|
+
query_params = {}
|
63
|
+
|
64
|
+
# header parameters
|
65
|
+
header_params = {}
|
66
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
69
|
+
# HTTP header 'Content-Type'
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
78
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
79
|
+
:header_params => header_params,
|
80
|
+
:query_params => query_params,
|
81
|
+
:form_params => form_params,
|
82
|
+
:body => post_body,
|
83
|
+
:auth_names => auth_names,
|
84
|
+
:return_type => 'DelayAutoOrdersResponse')
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#delay_auto_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
# Delete a rotating transaction gateway
|
91
|
+
# Delete a rotating transaction gateway
|
92
|
+
# @param rtg_oid The rtg_oid to delete.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [BaseResponse]
|
95
|
+
def delete_rotating_transaction_gateway(rtg_oid, opts = {})
|
96
|
+
data, _status_code, _headers = delete_rotating_transaction_gateway_with_http_info(rtg_oid, opts)
|
97
|
+
data
|
98
|
+
end
|
99
|
+
|
100
|
+
# Delete a rotating transaction gateway
|
101
|
+
# Delete a rotating transaction gateway
|
102
|
+
# @param rtg_oid The rtg_oid to delete.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
|
105
|
+
def delete_rotating_transaction_gateway_with_http_info(rtg_oid, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.delete_rotating_transaction_gateway ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'rtg_oid' is set
|
110
|
+
if @api_client.config.client_side_validation && rtg_oid.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.delete_rotating_transaction_gateway"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = {}
|
121
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
122
|
+
# HTTP header 'Accept' (if needed)
|
123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
124
|
+
# HTTP header 'Content-Type'
|
125
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
126
|
+
|
127
|
+
# form parameters
|
128
|
+
form_params = {}
|
129
|
+
|
130
|
+
# http body (model)
|
131
|
+
post_body = nil
|
132
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
133
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
134
|
+
:header_params => header_params,
|
135
|
+
:query_params => query_params,
|
136
|
+
:form_params => form_params,
|
137
|
+
:body => post_body,
|
138
|
+
:auth_names => auth_names,
|
139
|
+
:return_type => 'BaseResponse')
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#delete_rotating_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
# Retrieve payments configuration
|
146
|
+
# Retrieves payments configuration for this account.
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @return [PaymentsConfigurationResponse]
|
149
|
+
def get_payments_configuration(opts = {})
|
150
|
+
data, _status_code, _headers = get_payments_configuration_with_http_info(opts)
|
151
|
+
data
|
152
|
+
end
|
153
|
+
|
154
|
+
# Retrieve payments configuration
|
155
|
+
# Retrieves payments configuration for this account.
|
156
|
+
# @param [Hash] opts the optional parameters
|
157
|
+
# @return [Array<(PaymentsConfigurationResponse, Fixnum, Hash)>] PaymentsConfigurationResponse data, response status code and response headers
|
158
|
+
def get_payments_configuration_with_http_info(opts = {})
|
159
|
+
if @api_client.config.debugging
|
160
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_configuration ...'
|
161
|
+
end
|
162
|
+
# resource path
|
163
|
+
local_var_path = '/configuration/checkout/payments'
|
164
|
+
|
165
|
+
# query parameters
|
166
|
+
query_params = {}
|
167
|
+
|
168
|
+
# header parameters
|
169
|
+
header_params = {}
|
170
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
171
|
+
# HTTP header 'Accept' (if needed)
|
172
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
173
|
+
# HTTP header 'Content-Type'
|
174
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
175
|
+
|
176
|
+
# form parameters
|
177
|
+
form_params = {}
|
178
|
+
|
179
|
+
# http body (model)
|
180
|
+
post_body = nil
|
181
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
182
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
183
|
+
:header_params => header_params,
|
184
|
+
:query_params => query_params,
|
185
|
+
:form_params => form_params,
|
186
|
+
:body => post_body,
|
187
|
+
:auth_names => auth_names,
|
188
|
+
:return_type => 'PaymentsConfigurationResponse')
|
189
|
+
if @api_client.config.debugging
|
190
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
191
|
+
end
|
192
|
+
return data, status_code, headers
|
193
|
+
end
|
194
|
+
# Retrieve a rotating transaction gateway
|
195
|
+
# Retrieve a rotating transaction gateway
|
196
|
+
# @param rtg_oid The rtg_oid for the desired record.
|
197
|
+
# @param [Hash] opts the optional parameters
|
198
|
+
# @return [RotatingTransactionGatewayResponse]
|
199
|
+
def get_payments_rotating_gateway(rtg_oid, opts = {})
|
200
|
+
data, _status_code, _headers = get_payments_rotating_gateway_with_http_info(rtg_oid, opts)
|
201
|
+
data
|
202
|
+
end
|
203
|
+
|
204
|
+
# Retrieve a rotating transaction gateway
|
205
|
+
# Retrieve a rotating transaction gateway
|
206
|
+
# @param rtg_oid The rtg_oid for the desired record.
|
207
|
+
# @param [Hash] opts the optional parameters
|
208
|
+
# @return [Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>] RotatingTransactionGatewayResponse data, response status code and response headers
|
209
|
+
def get_payments_rotating_gateway_with_http_info(rtg_oid, opts = {})
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_gateway ...'
|
212
|
+
end
|
213
|
+
# verify the required parameter 'rtg_oid' is set
|
214
|
+
if @api_client.config.client_side_validation && rtg_oid.nil?
|
215
|
+
fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.get_payments_rotating_gateway"
|
216
|
+
end
|
217
|
+
# resource path
|
218
|
+
local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)
|
219
|
+
|
220
|
+
# query parameters
|
221
|
+
query_params = {}
|
222
|
+
|
223
|
+
# header parameters
|
224
|
+
header_params = {}
|
225
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
226
|
+
# HTTP header 'Accept' (if needed)
|
227
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
228
|
+
# HTTP header 'Content-Type'
|
229
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
230
|
+
|
231
|
+
# form parameters
|
232
|
+
form_params = {}
|
233
|
+
|
234
|
+
# http body (model)
|
235
|
+
post_body = nil
|
236
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
237
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
238
|
+
:header_params => header_params,
|
239
|
+
:query_params => query_params,
|
240
|
+
:form_params => form_params,
|
241
|
+
:body => post_body,
|
242
|
+
:auth_names => auth_names,
|
243
|
+
:return_type => 'RotatingTransactionGatewayResponse')
|
244
|
+
if @api_client.config.debugging
|
245
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_rotating_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
246
|
+
end
|
247
|
+
return data, status_code, headers
|
248
|
+
end
|
249
|
+
# Retrieve a rotating transaction gateway by code
|
250
|
+
# Retrieve a rotating transaction gateway by code
|
251
|
+
# @param code The code for the desired rotating transaction gateway.
|
252
|
+
# @param [Hash] opts the optional parameters
|
253
|
+
# @return [RotatingTransactionGatewayResponse]
|
254
|
+
def get_payments_rotating_gateway_by_code(code, opts = {})
|
255
|
+
data, _status_code, _headers = get_payments_rotating_gateway_by_code_with_http_info(code, opts)
|
256
|
+
data
|
257
|
+
end
|
258
|
+
|
259
|
+
# Retrieve a rotating transaction gateway by code
|
260
|
+
# Retrieve a rotating transaction gateway by code
|
261
|
+
# @param code The code for the desired rotating transaction gateway.
|
262
|
+
# @param [Hash] opts the optional parameters
|
263
|
+
# @return [Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>] RotatingTransactionGatewayResponse data, response status code and response headers
|
264
|
+
def get_payments_rotating_gateway_by_code_with_http_info(code, opts = {})
|
265
|
+
if @api_client.config.debugging
|
266
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_gateway_by_code ...'
|
267
|
+
end
|
268
|
+
# verify the required parameter 'code' is set
|
269
|
+
if @api_client.config.client_side_validation && code.nil?
|
270
|
+
fail ArgumentError, "Missing the required parameter 'code' when calling ConfigurationApi.get_payments_rotating_gateway_by_code"
|
271
|
+
end
|
272
|
+
# resource path
|
273
|
+
local_var_path = '/configuration/checkout/payments/rtg/byCode/{code}'.sub('{' + 'code' + '}', code.to_s)
|
274
|
+
|
275
|
+
# query parameters
|
276
|
+
query_params = {}
|
277
|
+
|
278
|
+
# header parameters
|
279
|
+
header_params = {}
|
280
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
281
|
+
# HTTP header 'Accept' (if needed)
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
283
|
+
# HTTP header 'Content-Type'
|
284
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
285
|
+
|
286
|
+
# form parameters
|
287
|
+
form_params = {}
|
288
|
+
|
289
|
+
# http body (model)
|
290
|
+
post_body = nil
|
291
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
292
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
293
|
+
:header_params => header_params,
|
294
|
+
:query_params => query_params,
|
295
|
+
:form_params => form_params,
|
296
|
+
:body => post_body,
|
297
|
+
:auth_names => auth_names,
|
298
|
+
:return_type => 'RotatingTransactionGatewayResponse')
|
299
|
+
if @api_client.config.debugging
|
300
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_rotating_gateway_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
301
|
+
end
|
302
|
+
return data, status_code, headers
|
303
|
+
end
|
304
|
+
# Retrieve a list of rotating transaction gateways
|
305
|
+
# Retrieve a list of rotating transaction gateways
|
306
|
+
# @param [Hash] opts the optional parameters
|
307
|
+
# @return [RotatingTransactionGatewaysResponse]
|
308
|
+
def get_payments_rotating_transaction_gateways(opts = {})
|
309
|
+
data, _status_code, _headers = get_payments_rotating_transaction_gateways_with_http_info(opts)
|
310
|
+
data
|
311
|
+
end
|
312
|
+
|
313
|
+
# Retrieve a list of rotating transaction gateways
|
314
|
+
# Retrieve a list of rotating transaction gateways
|
315
|
+
# @param [Hash] opts the optional parameters
|
316
|
+
# @return [Array<(RotatingTransactionGatewaysResponse, Fixnum, Hash)>] RotatingTransactionGatewaysResponse data, response status code and response headers
|
317
|
+
def get_payments_rotating_transaction_gateways_with_http_info(opts = {})
|
318
|
+
if @api_client.config.debugging
|
319
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_transaction_gateways ...'
|
320
|
+
end
|
321
|
+
# resource path
|
322
|
+
local_var_path = '/configuration/checkout/payments/rtg'
|
323
|
+
|
324
|
+
# query parameters
|
325
|
+
query_params = {}
|
326
|
+
|
327
|
+
# header parameters
|
328
|
+
header_params = {}
|
329
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
330
|
+
# HTTP header 'Accept' (if needed)
|
331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
332
|
+
# HTTP header 'Content-Type'
|
333
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
334
|
+
|
335
|
+
# form parameters
|
336
|
+
form_params = {}
|
337
|
+
|
338
|
+
# http body (model)
|
339
|
+
post_body = nil
|
340
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
341
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
342
|
+
:header_params => header_params,
|
343
|
+
:query_params => query_params,
|
344
|
+
:form_params => form_params,
|
345
|
+
:body => post_body,
|
346
|
+
:auth_names => auth_names,
|
347
|
+
:return_type => 'RotatingTransactionGatewaysResponse')
|
348
|
+
if @api_client.config.debugging
|
349
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_rotating_transaction_gateways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
350
|
+
end
|
351
|
+
return data, status_code, headers
|
352
|
+
end
|
353
|
+
# Retrieve a summary of rotating transaction gateways
|
354
|
+
# Retrieve a summary of rotating transaction gateways
|
355
|
+
# @param [Hash] opts the optional parameters
|
356
|
+
# @return [RtgSummaryResponse]
|
357
|
+
def get_payments_rtg_summaries(opts = {})
|
358
|
+
data, _status_code, _headers = get_payments_rtg_summaries_with_http_info(opts)
|
359
|
+
data
|
360
|
+
end
|
361
|
+
|
362
|
+
# Retrieve a summary of rotating transaction gateways
|
363
|
+
# Retrieve a summary of rotating transaction gateways
|
364
|
+
# @param [Hash] opts the optional parameters
|
365
|
+
# @return [Array<(RtgSummaryResponse, Fixnum, Hash)>] RtgSummaryResponse data, response status code and response headers
|
366
|
+
def get_payments_rtg_summaries_with_http_info(opts = {})
|
367
|
+
if @api_client.config.debugging
|
368
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rtg_summaries ...'
|
369
|
+
end
|
370
|
+
# resource path
|
371
|
+
local_var_path = '/configuration/checkout/payments/rtg/summaries'
|
372
|
+
|
373
|
+
# query parameters
|
374
|
+
query_params = {}
|
375
|
+
|
376
|
+
# header parameters
|
377
|
+
header_params = {}
|
378
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
379
|
+
# HTTP header 'Accept' (if needed)
|
380
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
381
|
+
# HTTP header 'Content-Type'
|
382
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
383
|
+
|
384
|
+
# form parameters
|
385
|
+
form_params = {}
|
386
|
+
|
387
|
+
# http body (model)
|
388
|
+
post_body = nil
|
389
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
390
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
391
|
+
:header_params => header_params,
|
392
|
+
:query_params => query_params,
|
393
|
+
:form_params => form_params,
|
394
|
+
:body => post_body,
|
395
|
+
:auth_names => auth_names,
|
396
|
+
:return_type => 'RtgSummaryResponse')
|
397
|
+
if @api_client.config.debugging
|
398
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_rtg_summaries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
399
|
+
end
|
400
|
+
return data, status_code, headers
|
401
|
+
end
|
402
|
+
# Retrieve a list of transaction gateways
|
403
|
+
# Retrieve a list of transaction gateways
|
404
|
+
# @param [Hash] opts the optional parameters
|
405
|
+
# @return [TransactionGatewaysResponse]
|
406
|
+
def get_payments_transaction_gateways(opts = {})
|
407
|
+
data, _status_code, _headers = get_payments_transaction_gateways_with_http_info(opts)
|
408
|
+
data
|
409
|
+
end
|
410
|
+
|
411
|
+
# Retrieve a list of transaction gateways
|
412
|
+
# Retrieve a list of transaction gateways
|
413
|
+
# @param [Hash] opts the optional parameters
|
414
|
+
# @return [Array<(TransactionGatewaysResponse, Fixnum, Hash)>] TransactionGatewaysResponse data, response status code and response headers
|
415
|
+
def get_payments_transaction_gateways_with_http_info(opts = {})
|
416
|
+
if @api_client.config.debugging
|
417
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_transaction_gateways ...'
|
418
|
+
end
|
419
|
+
# resource path
|
420
|
+
local_var_path = '/configuration/checkout/payments/tg'
|
421
|
+
|
422
|
+
# query parameters
|
423
|
+
query_params = {}
|
424
|
+
|
425
|
+
# header parameters
|
426
|
+
header_params = {}
|
427
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
428
|
+
# HTTP header 'Accept' (if needed)
|
429
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
430
|
+
# HTTP header 'Content-Type'
|
431
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
432
|
+
|
433
|
+
# form parameters
|
434
|
+
form_params = {}
|
435
|
+
|
436
|
+
# http body (model)
|
437
|
+
post_body = nil
|
438
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
439
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
440
|
+
:header_params => header_params,
|
441
|
+
:query_params => query_params,
|
442
|
+
:form_params => form_params,
|
443
|
+
:body => post_body,
|
444
|
+
:auth_names => auth_names,
|
445
|
+
:return_type => 'TransactionGatewaysResponse')
|
446
|
+
if @api_client.config.debugging
|
447
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#get_payments_transaction_gateways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
448
|
+
end
|
449
|
+
return data, status_code, headers
|
450
|
+
end
|
451
|
+
# Insert a rotating transaction gateway
|
452
|
+
# Insert a rotating transaction gateway
|
453
|
+
# @param rotating_transaction_gateway Rotating transaction gateway
|
454
|
+
# @param [Hash] opts the optional parameters
|
455
|
+
# @return [RotatingTransactionGatewayResponse]
|
456
|
+
def insert_rotating_transaction_gateway(rotating_transaction_gateway, opts = {})
|
457
|
+
data, _status_code, _headers = insert_rotating_transaction_gateway_with_http_info(rotating_transaction_gateway, opts)
|
458
|
+
data
|
459
|
+
end
|
460
|
+
|
461
|
+
# Insert a rotating transaction gateway
|
462
|
+
# Insert a rotating transaction gateway
|
463
|
+
# @param rotating_transaction_gateway Rotating transaction gateway
|
464
|
+
# @param [Hash] opts the optional parameters
|
465
|
+
# @return [Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>] RotatingTransactionGatewayResponse data, response status code and response headers
|
466
|
+
def insert_rotating_transaction_gateway_with_http_info(rotating_transaction_gateway, opts = {})
|
467
|
+
if @api_client.config.debugging
|
468
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.insert_rotating_transaction_gateway ...'
|
469
|
+
end
|
470
|
+
# verify the required parameter 'rotating_transaction_gateway' is set
|
471
|
+
if @api_client.config.client_side_validation && rotating_transaction_gateway.nil?
|
472
|
+
fail ArgumentError, "Missing the required parameter 'rotating_transaction_gateway' when calling ConfigurationApi.insert_rotating_transaction_gateway"
|
473
|
+
end
|
474
|
+
# resource path
|
475
|
+
local_var_path = '/configuration/checkout/payments/rtg/'
|
476
|
+
|
477
|
+
# query parameters
|
478
|
+
query_params = {}
|
479
|
+
|
480
|
+
# header parameters
|
481
|
+
header_params = {}
|
482
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
483
|
+
# HTTP header 'Accept' (if needed)
|
484
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
485
|
+
# HTTP header 'Content-Type'
|
486
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
487
|
+
|
488
|
+
# form parameters
|
489
|
+
form_params = {}
|
490
|
+
|
491
|
+
# http body (model)
|
492
|
+
post_body = @api_client.object_to_http_body(rotating_transaction_gateway)
|
493
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
494
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
495
|
+
:header_params => header_params,
|
496
|
+
:query_params => query_params,
|
497
|
+
:form_params => form_params,
|
498
|
+
:body => post_body,
|
499
|
+
:auth_names => auth_names,
|
500
|
+
:return_type => 'RotatingTransactionGatewayResponse')
|
501
|
+
if @api_client.config.debugging
|
502
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#insert_rotating_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
503
|
+
end
|
504
|
+
return data, status_code, headers
|
505
|
+
end
|
506
|
+
# Migrate a normal transaction gateway to a rotating transaction gateway
|
507
|
+
# Migrate a normal transaction gateway to a rotating transaction gateway
|
508
|
+
# @param code The short code for the new rotating transaction gateway
|
509
|
+
# @param [Hash] opts the optional parameters
|
510
|
+
# @return [RotatingTransactionGatewayResponse]
|
511
|
+
def migrate_to_rotating_transaction_gateway(code, opts = {})
|
512
|
+
data, _status_code, _headers = migrate_to_rotating_transaction_gateway_with_http_info(code, opts)
|
513
|
+
data
|
514
|
+
end
|
515
|
+
|
516
|
+
# Migrate a normal transaction gateway to a rotating transaction gateway
|
517
|
+
# Migrate a normal transaction gateway to a rotating transaction gateway
|
518
|
+
# @param code The short code for the new rotating transaction gateway
|
519
|
+
# @param [Hash] opts the optional parameters
|
520
|
+
# @return [Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>] RotatingTransactionGatewayResponse data, response status code and response headers
|
521
|
+
def migrate_to_rotating_transaction_gateway_with_http_info(code, opts = {})
|
522
|
+
if @api_client.config.debugging
|
523
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.migrate_to_rotating_transaction_gateway ...'
|
524
|
+
end
|
525
|
+
# verify the required parameter 'code' is set
|
526
|
+
if @api_client.config.client_side_validation && code.nil?
|
527
|
+
fail ArgumentError, "Missing the required parameter 'code' when calling ConfigurationApi.migrate_to_rotating_transaction_gateway"
|
528
|
+
end
|
529
|
+
# resource path
|
530
|
+
local_var_path = '/configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code}'.sub('{' + 'code' + '}', code.to_s)
|
531
|
+
|
532
|
+
# query parameters
|
533
|
+
query_params = {}
|
534
|
+
|
535
|
+
# header parameters
|
536
|
+
header_params = {}
|
537
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
538
|
+
# HTTP header 'Accept' (if needed)
|
539
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
540
|
+
# HTTP header 'Content-Type'
|
541
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
542
|
+
|
543
|
+
# form parameters
|
544
|
+
form_params = {}
|
545
|
+
|
546
|
+
# http body (model)
|
547
|
+
post_body = nil
|
548
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
549
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
550
|
+
:header_params => header_params,
|
551
|
+
:query_params => query_params,
|
552
|
+
:form_params => form_params,
|
553
|
+
:body => post_body,
|
554
|
+
:auth_names => auth_names,
|
555
|
+
:return_type => 'RotatingTransactionGatewayResponse')
|
556
|
+
if @api_client.config.debugging
|
557
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#migrate_to_rotating_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
558
|
+
end
|
559
|
+
return data, status_code, headers
|
560
|
+
end
|
561
|
+
# Begin the processing of connecting with Stripe
|
562
|
+
# Begin the processing of connecting with Stripe.
|
563
|
+
# @param rtg_oid The rtg_oid to be connected to stripe.
|
564
|
+
# @param [Hash] opts the optional parameters
|
565
|
+
# @return [StripeConnectResponse]
|
566
|
+
def stripe_connect(rtg_oid, opts = {})
|
567
|
+
data, _status_code, _headers = stripe_connect_with_http_info(rtg_oid, opts)
|
568
|
+
data
|
569
|
+
end
|
570
|
+
|
571
|
+
# Begin the processing of connecting with Stripe
|
572
|
+
# Begin the processing of connecting with Stripe.
|
573
|
+
# @param rtg_oid The rtg_oid to be connected to stripe.
|
574
|
+
# @param [Hash] opts the optional parameters
|
575
|
+
# @return [Array<(StripeConnectResponse, Fixnum, Hash)>] StripeConnectResponse data, response status code and response headers
|
576
|
+
def stripe_connect_with_http_info(rtg_oid, opts = {})
|
577
|
+
if @api_client.config.debugging
|
578
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.stripe_connect ...'
|
579
|
+
end
|
580
|
+
# verify the required parameter 'rtg_oid' is set
|
581
|
+
if @api_client.config.client_side_validation && rtg_oid.nil?
|
582
|
+
fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.stripe_connect"
|
583
|
+
end
|
584
|
+
# resource path
|
585
|
+
local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)
|
586
|
+
|
587
|
+
# query parameters
|
588
|
+
query_params = {}
|
589
|
+
|
590
|
+
# header parameters
|
591
|
+
header_params = {}
|
592
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
593
|
+
# HTTP header 'Accept' (if needed)
|
594
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
595
|
+
# HTTP header 'Content-Type'
|
596
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
597
|
+
|
598
|
+
# form parameters
|
599
|
+
form_params = {}
|
600
|
+
|
601
|
+
# http body (model)
|
602
|
+
post_body = nil
|
603
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
604
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
605
|
+
:header_params => header_params,
|
606
|
+
:query_params => query_params,
|
607
|
+
:form_params => form_params,
|
608
|
+
:body => post_body,
|
609
|
+
:auth_names => auth_names,
|
610
|
+
:return_type => 'StripeConnectResponse')
|
611
|
+
if @api_client.config.debugging
|
612
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#stripe_connect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
613
|
+
end
|
614
|
+
return data, status_code, headers
|
615
|
+
end
|
616
|
+
# Updates payments configuration
|
617
|
+
# Updates payments configuration on the UltraCart account.
|
618
|
+
# @param payments_configuration Payments configuration
|
619
|
+
# @param [Hash] opts the optional parameters
|
620
|
+
# @return [PaymentsConfigurationResponse]
|
621
|
+
def update_payments_configuration(payments_configuration, opts = {})
|
622
|
+
data, _status_code, _headers = update_payments_configuration_with_http_info(payments_configuration, opts)
|
623
|
+
data
|
624
|
+
end
|
625
|
+
|
626
|
+
# Updates payments configuration
|
627
|
+
# Updates payments configuration on the UltraCart account.
|
628
|
+
# @param payments_configuration Payments configuration
|
629
|
+
# @param [Hash] opts the optional parameters
|
630
|
+
# @return [Array<(PaymentsConfigurationResponse, Fixnum, Hash)>] PaymentsConfigurationResponse data, response status code and response headers
|
631
|
+
def update_payments_configuration_with_http_info(payments_configuration, opts = {})
|
632
|
+
if @api_client.config.debugging
|
633
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.update_payments_configuration ...'
|
634
|
+
end
|
635
|
+
# verify the required parameter 'payments_configuration' is set
|
636
|
+
if @api_client.config.client_side_validation && payments_configuration.nil?
|
637
|
+
fail ArgumentError, "Missing the required parameter 'payments_configuration' when calling ConfigurationApi.update_payments_configuration"
|
638
|
+
end
|
639
|
+
# resource path
|
640
|
+
local_var_path = '/configuration/checkout/payments'
|
641
|
+
|
642
|
+
# query parameters
|
643
|
+
query_params = {}
|
644
|
+
|
645
|
+
# header parameters
|
646
|
+
header_params = {}
|
647
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
648
|
+
# HTTP header 'Accept' (if needed)
|
649
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
650
|
+
# HTTP header 'Content-Type'
|
651
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
652
|
+
|
653
|
+
# form parameters
|
654
|
+
form_params = {}
|
655
|
+
|
656
|
+
# http body (model)
|
657
|
+
post_body = @api_client.object_to_http_body(payments_configuration)
|
658
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
659
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
660
|
+
:header_params => header_params,
|
661
|
+
:query_params => query_params,
|
662
|
+
:form_params => form_params,
|
663
|
+
:body => post_body,
|
664
|
+
:auth_names => auth_names,
|
665
|
+
:return_type => 'PaymentsConfigurationResponse')
|
666
|
+
if @api_client.config.debugging
|
667
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#update_payments_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
668
|
+
end
|
669
|
+
return data, status_code, headers
|
670
|
+
end
|
671
|
+
# Updates payments transaction gateway
|
672
|
+
# Updates payments transaction gateway on the UltraCart account.
|
673
|
+
# @param update_gateway_request Transaction gateways
|
674
|
+
# @param [Hash] opts the optional parameters
|
675
|
+
# @return [TransactionGatewaysResponse]
|
676
|
+
def update_payments_transaction_gateway(update_gateway_request, opts = {})
|
677
|
+
data, _status_code, _headers = update_payments_transaction_gateway_with_http_info(update_gateway_request, opts)
|
678
|
+
data
|
679
|
+
end
|
680
|
+
|
681
|
+
# Updates payments transaction gateway
|
682
|
+
# Updates payments transaction gateway on the UltraCart account.
|
683
|
+
# @param update_gateway_request Transaction gateways
|
684
|
+
# @param [Hash] opts the optional parameters
|
685
|
+
# @return [Array<(TransactionGatewaysResponse, Fixnum, Hash)>] TransactionGatewaysResponse data, response status code and response headers
|
686
|
+
def update_payments_transaction_gateway_with_http_info(update_gateway_request, opts = {})
|
687
|
+
if @api_client.config.debugging
|
688
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.update_payments_transaction_gateway ...'
|
689
|
+
end
|
690
|
+
# verify the required parameter 'update_gateway_request' is set
|
691
|
+
if @api_client.config.client_side_validation && update_gateway_request.nil?
|
692
|
+
fail ArgumentError, "Missing the required parameter 'update_gateway_request' when calling ConfigurationApi.update_payments_transaction_gateway"
|
693
|
+
end
|
694
|
+
# resource path
|
695
|
+
local_var_path = '/configuration/checkout/payments/tg'
|
696
|
+
|
697
|
+
# query parameters
|
698
|
+
query_params = {}
|
699
|
+
|
700
|
+
# header parameters
|
701
|
+
header_params = {}
|
702
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
703
|
+
# HTTP header 'Accept' (if needed)
|
704
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
705
|
+
# HTTP header 'Content-Type'
|
706
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
707
|
+
|
708
|
+
# form parameters
|
709
|
+
form_params = {}
|
710
|
+
|
711
|
+
# http body (model)
|
712
|
+
post_body = @api_client.object_to_http_body(update_gateway_request)
|
713
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
714
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
715
|
+
:header_params => header_params,
|
716
|
+
:query_params => query_params,
|
717
|
+
:form_params => form_params,
|
718
|
+
:body => post_body,
|
719
|
+
:auth_names => auth_names,
|
720
|
+
:return_type => 'TransactionGatewaysResponse')
|
721
|
+
if @api_client.config.debugging
|
722
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#update_payments_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
723
|
+
end
|
724
|
+
return data, status_code, headers
|
725
|
+
end
|
726
|
+
# Update a rotating transaction gateway
|
727
|
+
# Update a rotating transaction gateway
|
728
|
+
# @param rtg_oid The rtg_oid to update.
|
729
|
+
# @param rotating_transaction_gateway Rotating transaction gateway
|
730
|
+
# @param [Hash] opts the optional parameters
|
731
|
+
# @return [RotatingTransactionGateway]
|
732
|
+
def update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway, opts = {})
|
733
|
+
data, _status_code, _headers = update_rotating_transaction_gateway_with_http_info(rtg_oid, rotating_transaction_gateway, opts)
|
734
|
+
data
|
735
|
+
end
|
736
|
+
|
737
|
+
# Update a rotating transaction gateway
|
738
|
+
# Update a rotating transaction gateway
|
739
|
+
# @param rtg_oid The rtg_oid to update.
|
740
|
+
# @param rotating_transaction_gateway Rotating transaction gateway
|
741
|
+
# @param [Hash] opts the optional parameters
|
742
|
+
# @return [Array<(RotatingTransactionGateway, Fixnum, Hash)>] RotatingTransactionGateway data, response status code and response headers
|
743
|
+
def update_rotating_transaction_gateway_with_http_info(rtg_oid, rotating_transaction_gateway, opts = {})
|
744
|
+
if @api_client.config.debugging
|
745
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.update_rotating_transaction_gateway ...'
|
746
|
+
end
|
747
|
+
# verify the required parameter 'rtg_oid' is set
|
748
|
+
if @api_client.config.client_side_validation && rtg_oid.nil?
|
749
|
+
fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.update_rotating_transaction_gateway"
|
750
|
+
end
|
751
|
+
# verify the required parameter 'rotating_transaction_gateway' is set
|
752
|
+
if @api_client.config.client_side_validation && rotating_transaction_gateway.nil?
|
753
|
+
fail ArgumentError, "Missing the required parameter 'rotating_transaction_gateway' when calling ConfigurationApi.update_rotating_transaction_gateway"
|
754
|
+
end
|
755
|
+
# resource path
|
756
|
+
local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)
|
757
|
+
|
758
|
+
# query parameters
|
759
|
+
query_params = {}
|
760
|
+
|
761
|
+
# header parameters
|
762
|
+
header_params = {}
|
763
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
764
|
+
# HTTP header 'Accept' (if needed)
|
765
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
766
|
+
# HTTP header 'Content-Type'
|
767
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
768
|
+
|
769
|
+
# form parameters
|
770
|
+
form_params = {}
|
771
|
+
|
772
|
+
# http body (model)
|
773
|
+
post_body = @api_client.object_to_http_body(rotating_transaction_gateway)
|
774
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
775
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
776
|
+
:header_params => header_params,
|
777
|
+
:query_params => query_params,
|
778
|
+
:form_params => form_params,
|
779
|
+
:body => post_body,
|
780
|
+
:auth_names => auth_names,
|
781
|
+
:return_type => 'RotatingTransactionGateway')
|
782
|
+
if @api_client.config.debugging
|
783
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#update_rotating_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
784
|
+
end
|
785
|
+
return data, status_code, headers
|
786
|
+
end
|
787
|
+
# Enroll with WePay
|
788
|
+
# Enroll with WePay on the UltraCart account.
|
789
|
+
# @param wepay_enroll Wepay enrollment information
|
790
|
+
# @param [Hash] opts the optional parameters
|
791
|
+
# @return [PaymentsConfigurationResponse]
|
792
|
+
def wepay_enroll(wepay_enroll, opts = {})
|
793
|
+
data, _status_code, _headers = wepay_enroll_with_http_info(wepay_enroll, opts)
|
794
|
+
data
|
795
|
+
end
|
796
|
+
|
797
|
+
# Enroll with WePay
|
798
|
+
# Enroll with WePay on the UltraCart account.
|
799
|
+
# @param wepay_enroll Wepay enrollment information
|
800
|
+
# @param [Hash] opts the optional parameters
|
801
|
+
# @return [Array<(PaymentsConfigurationResponse, Fixnum, Hash)>] PaymentsConfigurationResponse data, response status code and response headers
|
802
|
+
def wepay_enroll_with_http_info(wepay_enroll, opts = {})
|
803
|
+
if @api_client.config.debugging
|
804
|
+
@api_client.config.logger.debug 'Calling API: ConfigurationApi.wepay_enroll ...'
|
805
|
+
end
|
806
|
+
# verify the required parameter 'wepay_enroll' is set
|
807
|
+
if @api_client.config.client_side_validation && wepay_enroll.nil?
|
808
|
+
fail ArgumentError, "Missing the required parameter 'wepay_enroll' when calling ConfigurationApi.wepay_enroll"
|
809
|
+
end
|
810
|
+
# resource path
|
811
|
+
local_var_path = '/configuration/checkout/wepayEnroll'
|
812
|
+
|
813
|
+
# query parameters
|
814
|
+
query_params = {}
|
815
|
+
|
816
|
+
# header parameters
|
817
|
+
header_params = {}
|
818
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
819
|
+
# HTTP header 'Accept' (if needed)
|
820
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
821
|
+
# HTTP header 'Content-Type'
|
822
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
823
|
+
|
824
|
+
# form parameters
|
825
|
+
form_params = {}
|
826
|
+
|
827
|
+
# http body (model)
|
828
|
+
post_body = @api_client.object_to_http_body(wepay_enroll)
|
829
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
830
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
831
|
+
:header_params => header_params,
|
832
|
+
:query_params => query_params,
|
833
|
+
:form_params => form_params,
|
834
|
+
:body => post_body,
|
835
|
+
:auth_names => auth_names,
|
836
|
+
:return_type => 'PaymentsConfigurationResponse')
|
837
|
+
if @api_client.config.debugging
|
838
|
+
@api_client.config.logger.debug "API called: ConfigurationApi#wepay_enroll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
839
|
+
end
|
840
|
+
return data, status_code, headers
|
841
|
+
end
|
842
|
+
end
|
843
|
+
end
|