ultracart_api 3.2.15 → 3.4.0
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/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/RtgCurrency.md +10 -0
- data/docs/RtgDayOfMonthRestriction.md +9 -0
- data/docs/RtgDayOfWeekRestriction.md +10 -0
- data/docs/RtgThemeRestriction.md +10 -0
- data/docs/ScreenRecordingPageViewEvent.md +1 -0
- data/docs/SingleSignOnAuthorizeRequest.md +9 -0
- data/docs/SingleSignOnAuthorizeResponse.md +9 -0
- data/docs/SingleSignOnTokenRequest.md +9 -0
- data/docs/SingleSignOnTokenResponse.md +10 -0
- data/docs/SsoApi.md +201 -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 +34 -0
- data/lib/ultracart_api/api/configuration_api.rb +843 -0
- data/lib/ultracart_api/api/sso_api.rb +243 -0
- data/lib/ultracart_api/models/delay_auto_orders_response.rb +221 -0
- 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/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_theme_restriction.rb +239 -0
- data/lib/ultracart_api/models/screen_recording_page_view_event.rb +10 -1
- data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_token_request.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_token_response.rb +205 -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 +70 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9786b13898c349136d94a39a4ac0c4b8d456d5cd921fee9f3cb944720ce643b1
|
4
|
+
data.tar.gz: b2929833e5d3933811cf41ae655c5367399f5ab81e1040de8b91c17f6d60fbb8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f6473445e5358a5dfbc7a01c74c41afb10625c5be4c36663d852205a3364a7c0ba70bc0c3f4d7f4fda4a675fe36710222ee1d341af6fb057eed26dfadf99fad2
|
7
|
+
data.tar.gz: d38d9e0d1b69aec895b42dfb343cbdf1b1c5d5ff899f8328740f91f0255eedd1cbf4f632138203adad00f0fdf6f11a72c4c3fb4ed9b9f76a02f32b9467934f18
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.4.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.
|
27
|
+
gem install ./ultracart_api-3.4.0.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.4.0.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.
|
35
|
+
gem 'ultracart_api', '~> 3.4.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -120,6 +120,21 @@ Class | Method | HTTP request | Description
|
|
120
120
|
*UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
121
121
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
122
122
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
123
|
+
*UltracartClient::ConfigurationApi* | [**delay_auto_orders**](docs/ConfigurationApi.md#delay_auto_orders) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders | Delay auto order processing for a day for this rotating transaction gateway
|
124
|
+
*UltracartClient::ConfigurationApi* | [**delete_rotating_transaction_gateway**](docs/ConfigurationApi.md#delete_rotating_transaction_gateway) | **DELETE** /configuration/checkout/payments/rtg/{rtg_oid} | Delete a rotating transaction gateway
|
125
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_configuration**](docs/ConfigurationApi.md#get_payments_configuration) | **GET** /configuration/checkout/payments | Retrieve payments configuration
|
126
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_rotating_gateway**](docs/ConfigurationApi.md#get_payments_rotating_gateway) | **GET** /configuration/checkout/payments/rtg/{rtg_oid} | Retrieve a rotating transaction gateway
|
127
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_rotating_gateway_by_code**](docs/ConfigurationApi.md#get_payments_rotating_gateway_by_code) | **GET** /configuration/checkout/payments/rtg/byCode/{code} | Retrieve a rotating transaction gateway by code
|
128
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_rotating_transaction_gateways**](docs/ConfigurationApi.md#get_payments_rotating_transaction_gateways) | **GET** /configuration/checkout/payments/rtg | Retrieve a list of rotating transaction gateways
|
129
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_rtg_summaries**](docs/ConfigurationApi.md#get_payments_rtg_summaries) | **GET** /configuration/checkout/payments/rtg/summaries | Retrieve a summary of rotating transaction gateways
|
130
|
+
*UltracartClient::ConfigurationApi* | [**get_payments_transaction_gateways**](docs/ConfigurationApi.md#get_payments_transaction_gateways) | **GET** /configuration/checkout/payments/tg | Retrieve a list of transaction gateways
|
131
|
+
*UltracartClient::ConfigurationApi* | [**insert_rotating_transaction_gateway**](docs/ConfigurationApi.md#insert_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/rtg/ | Insert a rotating transaction gateway
|
132
|
+
*UltracartClient::ConfigurationApi* | [**migrate_to_rotating_transaction_gateway**](docs/ConfigurationApi.md#migrate_to_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code} | Migrate a normal transaction gateway to a rotating transaction gateway
|
133
|
+
*UltracartClient::ConfigurationApi* | [**stripe_connect**](docs/ConfigurationApi.md#stripe_connect) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect | Begin the processing of connecting with Stripe
|
134
|
+
*UltracartClient::ConfigurationApi* | [**update_payments_configuration**](docs/ConfigurationApi.md#update_payments_configuration) | **PUT** /configuration/checkout/payments | Updates payments configuration
|
135
|
+
*UltracartClient::ConfigurationApi* | [**update_payments_transaction_gateway**](docs/ConfigurationApi.md#update_payments_transaction_gateway) | **PUT** /configuration/checkout/payments/tg | Updates payments transaction gateway
|
136
|
+
*UltracartClient::ConfigurationApi* | [**update_rotating_transaction_gateway**](docs/ConfigurationApi.md#update_rotating_transaction_gateway) | **PUT** /configuration/checkout/payments/rtg/{rtg_oid} | Update a rotating transaction gateway
|
137
|
+
*UltracartClient::ConfigurationApi* | [**wepay_enroll**](docs/ConfigurationApi.md#wepay_enroll) | **PUT** /configuration/checkout/wepayEnroll | Enroll with WePay
|
123
138
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
124
139
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
125
140
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
@@ -194,6 +209,10 @@ Class | Method | HTTP request | Description
|
|
194
209
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
195
210
|
*UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
|
196
211
|
*UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
|
212
|
+
*UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
|
213
|
+
*UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
|
214
|
+
*UltracartClient::SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
|
215
|
+
*UltracartClient::SsoApi* | [**sso_token**](docs/SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
|
197
216
|
*UltracartClient::StorefrontApi* | [**add_to_library**](docs/StorefrontApi.md#add_to_library) | **POST** /storefront/code_library | Add to library
|
198
217
|
*UltracartClient::StorefrontApi* | [**apply_to_store_front**](docs/StorefrontApi.md#apply_to_store_front) | **POST** /storefront/code_library/apply | Apply library item to storefront.
|
199
218
|
*UltracartClient::StorefrontApi* | [**archive_email_list**](docs/StorefrontApi.md#archive_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive | Archive email list
|
@@ -582,6 +601,7 @@ Class | Method | HTTP request | Description
|
|
582
601
|
- [UltracartClient::CustomerTaxCodes](docs/CustomerTaxCodes.md)
|
583
602
|
- [UltracartClient::CustomersResponse](docs/CustomersResponse.md)
|
584
603
|
- [UltracartClient::DataTablesServerSideResponse](docs/DataTablesServerSideResponse.md)
|
604
|
+
- [UltracartClient::DelayAutoOrdersResponse](docs/DelayAutoOrdersResponse.md)
|
585
605
|
- [UltracartClient::Distance](docs/Distance.md)
|
586
606
|
- [UltracartClient::DistributionCenter](docs/DistributionCenter.md)
|
587
607
|
- [UltracartClient::DistributionCentersResponse](docs/DistributionCentersResponse.md)
|
@@ -860,6 +880,24 @@ Class | Method | HTTP request | Description
|
|
860
880
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
861
881
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
862
882
|
- [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
|
883
|
+
- [UltracartClient::PaymentsConfiguration](docs/PaymentsConfiguration.md)
|
884
|
+
- [UltracartClient::PaymentsConfigurationAffirm](docs/PaymentsConfigurationAffirm.md)
|
885
|
+
- [UltracartClient::PaymentsConfigurationAmazon](docs/PaymentsConfigurationAmazon.md)
|
886
|
+
- [UltracartClient::PaymentsConfigurationCOD](docs/PaymentsConfigurationCOD.md)
|
887
|
+
- [UltracartClient::PaymentsConfigurationCash](docs/PaymentsConfigurationCash.md)
|
888
|
+
- [UltracartClient::PaymentsConfigurationCheck](docs/PaymentsConfigurationCheck.md)
|
889
|
+
- [UltracartClient::PaymentsConfigurationCreditCard](docs/PaymentsConfigurationCreditCard.md)
|
890
|
+
- [UltracartClient::PaymentsConfigurationLoanHero](docs/PaymentsConfigurationLoanHero.md)
|
891
|
+
- [UltracartClient::PaymentsConfigurationPayPal](docs/PaymentsConfigurationPayPal.md)
|
892
|
+
- [UltracartClient::PaymentsConfigurationPurchaseOrder](docs/PaymentsConfigurationPurchaseOrder.md)
|
893
|
+
- [UltracartClient::PaymentsConfigurationQuoteRequest](docs/PaymentsConfigurationQuoteRequest.md)
|
894
|
+
- [UltracartClient::PaymentsConfigurationResponse](docs/PaymentsConfigurationResponse.md)
|
895
|
+
- [UltracartClient::PaymentsConfigurationRestrictions](docs/PaymentsConfigurationRestrictions.md)
|
896
|
+
- [UltracartClient::PaymentsConfigurationSezzle](docs/PaymentsConfigurationSezzle.md)
|
897
|
+
- [UltracartClient::PaymentsConfigurationWePay](docs/PaymentsConfigurationWePay.md)
|
898
|
+
- [UltracartClient::PaymentsConfigurationWireTransfer](docs/PaymentsConfigurationWireTransfer.md)
|
899
|
+
- [UltracartClient::PaymentsThemeTransactionType](docs/PaymentsThemeTransactionType.md)
|
900
|
+
- [UltracartClient::PaymentsWepayEnroll](docs/PaymentsWepayEnroll.md)
|
863
901
|
- [UltracartClient::Permission](docs/Permission.md)
|
864
902
|
- [UltracartClient::PricingTier](docs/PricingTier.md)
|
865
903
|
- [UltracartClient::PricingTierNotification](docs/PricingTierNotification.md)
|
@@ -870,6 +908,11 @@ Class | Method | HTTP request | Description
|
|
870
908
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
871
909
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
872
910
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
911
|
+
- [UltracartClient::RotatingTransactionGateway](docs/RotatingTransactionGateway.md)
|
912
|
+
- [UltracartClient::RtgCurrency](docs/RtgCurrency.md)
|
913
|
+
- [UltracartClient::RtgDayOfMonthRestriction](docs/RtgDayOfMonthRestriction.md)
|
914
|
+
- [UltracartClient::RtgDayOfWeekRestriction](docs/RtgDayOfWeekRestriction.md)
|
915
|
+
- [UltracartClient::RtgThemeRestriction](docs/RtgThemeRestriction.md)
|
873
916
|
- [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
|
874
917
|
- [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
|
875
918
|
- [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
|
@@ -921,9 +964,14 @@ Class | Method | HTTP request | Description
|
|
921
964
|
- [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
|
922
965
|
- [UltracartClient::SelfConfig](docs/SelfConfig.md)
|
923
966
|
- [UltracartClient::SimpleValue](docs/SimpleValue.md)
|
967
|
+
- [UltracartClient::SingleSignOnAuthorizeRequest](docs/SingleSignOnAuthorizeRequest.md)
|
968
|
+
- [UltracartClient::SingleSignOnAuthorizeResponse](docs/SingleSignOnAuthorizeResponse.md)
|
969
|
+
- [UltracartClient::SingleSignOnTokenRequest](docs/SingleSignOnTokenRequest.md)
|
970
|
+
- [UltracartClient::SingleSignOnTokenResponse](docs/SingleSignOnTokenResponse.md)
|
924
971
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
925
972
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
926
973
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
974
|
+
- [UltracartClient::StripeConnectResponse](docs/StripeConnectResponse.md)
|
927
975
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
928
976
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
929
977
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
@@ -953,6 +1001,9 @@ Class | Method | HTTP request | Description
|
|
953
1001
|
- [UltracartClient::TransactionEmailListResponse](docs/TransactionEmailListResponse.md)
|
954
1002
|
- [UltracartClient::TransactionEmailOption](docs/TransactionEmailOption.md)
|
955
1003
|
- [UltracartClient::TransactionEmailResponse](docs/TransactionEmailResponse.md)
|
1004
|
+
- [UltracartClient::TransactionGateway](docs/TransactionGateway.md)
|
1005
|
+
- [UltracartClient::TransactionGatewaysRequest](docs/TransactionGatewaysRequest.md)
|
1006
|
+
- [UltracartClient::TransactionGatewaysResponse](docs/TransactionGatewaysResponse.md)
|
956
1007
|
- [UltracartClient::UltraCartConfig](docs/UltraCartConfig.md)
|
957
1008
|
- [UltracartClient::UploadCouponCodesRequest](docs/UploadCouponCodesRequest.md)
|
958
1009
|
- [UltracartClient::UploadCouponCodesResponse](docs/UploadCouponCodesResponse.md)
|
@@ -1001,6 +1052,8 @@ Class | Method | HTTP request | Description
|
|
1001
1052
|
- chargeback_write: Allows you to write chargeback information.
|
1002
1053
|
- checkout_read: Allows you to read checkout information.
|
1003
1054
|
- checkout_write: Allows you to write checkout information.
|
1055
|
+
- configuration_read: Allows you to read configuration information.
|
1056
|
+
- configuration_write: Allows you to write configuration information.
|
1004
1057
|
- coupon_read: Allows you to read coupon information.
|
1005
1058
|
- coupon_write: Allows you to write coupon information.
|
1006
1059
|
- customer_read: Allows you to read customer information.
|
@@ -1038,6 +1091,10 @@ Not every change is committed to every SDK.
|
|
1038
1091
|
|
1039
1092
|
| Version | Date | Comments |
|
1040
1093
|
| --: | :-: | --- |
|
1094
|
+
| 3.4.0 | 07/29/2021 | added new configuration api (not live yet. sdk only works against development presently) |
|
1095
|
+
| 3.3.2 | 07/16/2021 | sso bug fixes |
|
1096
|
+
| 3.3.1 | 07/16/2021 | screen recording - event sub text used for assisting in UX rendering |
|
1097
|
+
| 3.3.0 | 07/16/2021 | new endpoint SingleSignOn |
|
1041
1098
|
| 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs |
|
1042
1099
|
| 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api |
|
1043
1100
|
| 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag |
|
@@ -0,0 +1,756 @@
|
|
1
|
+
# UltracartClient::ConfigurationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delay_auto_orders**](ConfigurationApi.md#delay_auto_orders) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders | Delay auto order processing for a day for this rotating transaction gateway
|
8
|
+
[**delete_rotating_transaction_gateway**](ConfigurationApi.md#delete_rotating_transaction_gateway) | **DELETE** /configuration/checkout/payments/rtg/{rtg_oid} | Delete a rotating transaction gateway
|
9
|
+
[**get_payments_configuration**](ConfigurationApi.md#get_payments_configuration) | **GET** /configuration/checkout/payments | Retrieve payments configuration
|
10
|
+
[**get_payments_rotating_gateway**](ConfigurationApi.md#get_payments_rotating_gateway) | **GET** /configuration/checkout/payments/rtg/{rtg_oid} | Retrieve a rotating transaction gateway
|
11
|
+
[**get_payments_rotating_gateway_by_code**](ConfigurationApi.md#get_payments_rotating_gateway_by_code) | **GET** /configuration/checkout/payments/rtg/byCode/{code} | Retrieve a rotating transaction gateway by code
|
12
|
+
[**get_payments_rotating_transaction_gateways**](ConfigurationApi.md#get_payments_rotating_transaction_gateways) | **GET** /configuration/checkout/payments/rtg | Retrieve a list of rotating transaction gateways
|
13
|
+
[**get_payments_rtg_summaries**](ConfigurationApi.md#get_payments_rtg_summaries) | **GET** /configuration/checkout/payments/rtg/summaries | Retrieve a summary of rotating transaction gateways
|
14
|
+
[**get_payments_transaction_gateways**](ConfigurationApi.md#get_payments_transaction_gateways) | **GET** /configuration/checkout/payments/tg | Retrieve a list of transaction gateways
|
15
|
+
[**insert_rotating_transaction_gateway**](ConfigurationApi.md#insert_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/rtg/ | Insert a rotating transaction gateway
|
16
|
+
[**migrate_to_rotating_transaction_gateway**](ConfigurationApi.md#migrate_to_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code} | Migrate a normal transaction gateway to a rotating transaction gateway
|
17
|
+
[**stripe_connect**](ConfigurationApi.md#stripe_connect) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect | Begin the processing of connecting with Stripe
|
18
|
+
[**update_payments_configuration**](ConfigurationApi.md#update_payments_configuration) | **PUT** /configuration/checkout/payments | Updates payments configuration
|
19
|
+
[**update_payments_transaction_gateway**](ConfigurationApi.md#update_payments_transaction_gateway) | **PUT** /configuration/checkout/payments/tg | Updates payments transaction gateway
|
20
|
+
[**update_rotating_transaction_gateway**](ConfigurationApi.md#update_rotating_transaction_gateway) | **PUT** /configuration/checkout/payments/rtg/{rtg_oid} | Update a rotating transaction gateway
|
21
|
+
[**wepay_enroll**](ConfigurationApi.md#wepay_enroll) | **PUT** /configuration/checkout/wepayEnroll | Enroll with WePay
|
22
|
+
|
23
|
+
|
24
|
+
# **delay_auto_orders**
|
25
|
+
> DelayAutoOrdersResponse delay_auto_orders(rtg_oid)
|
26
|
+
|
27
|
+
Delay auto order processing for a day for this rotating transaction gateway
|
28
|
+
|
29
|
+
Delay auto order processing for a day for this rotating transaction gateway
|
30
|
+
|
31
|
+
### Example
|
32
|
+
```ruby
|
33
|
+
# load the gem
|
34
|
+
require 'ultracart_api'
|
35
|
+
|
36
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
37
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
38
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
39
|
+
|
40
|
+
|
41
|
+
rtg_oid = 56 # Integer | The rtg_oid to delay.
|
42
|
+
|
43
|
+
|
44
|
+
begin
|
45
|
+
#Delay auto order processing for a day for this rotating transaction gateway
|
46
|
+
result = api_instance.delay_auto_orders(rtg_oid)
|
47
|
+
p result
|
48
|
+
rescue UltracartClient::ApiError => e
|
49
|
+
puts "Exception when calling ConfigurationApi->delay_auto_orders: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**rtg_oid** | **Integer**| The rtg_oid to delay. |
|
58
|
+
|
59
|
+
### Return type
|
60
|
+
|
61
|
+
[**DelayAutoOrdersResponse**](DelayAutoOrdersResponse.md)
|
62
|
+
|
63
|
+
### Authorization
|
64
|
+
|
65
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
66
|
+
|
67
|
+
### HTTP request headers
|
68
|
+
|
69
|
+
- **Content-Type**: application/json; charset=UTF-8
|
70
|
+
- **Accept**: application/json
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
# **delete_rotating_transaction_gateway**
|
75
|
+
> BaseResponse delete_rotating_transaction_gateway(rtg_oid)
|
76
|
+
|
77
|
+
Delete a rotating transaction gateway
|
78
|
+
|
79
|
+
Delete a rotating transaction gateway
|
80
|
+
|
81
|
+
### Example
|
82
|
+
```ruby
|
83
|
+
# load the gem
|
84
|
+
require 'ultracart_api'
|
85
|
+
|
86
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
87
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
88
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
89
|
+
|
90
|
+
|
91
|
+
rtg_oid = 56 # Integer | The rtg_oid to delete.
|
92
|
+
|
93
|
+
|
94
|
+
begin
|
95
|
+
#Delete a rotating transaction gateway
|
96
|
+
result = api_instance.delete_rotating_transaction_gateway(rtg_oid)
|
97
|
+
p result
|
98
|
+
rescue UltracartClient::ApiError => e
|
99
|
+
puts "Exception when calling ConfigurationApi->delete_rotating_transaction_gateway: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
Name | Type | Description | Notes
|
106
|
+
------------- | ------------- | ------------- | -------------
|
107
|
+
**rtg_oid** | **Integer**| The rtg_oid to delete. |
|
108
|
+
|
109
|
+
### Return type
|
110
|
+
|
111
|
+
[**BaseResponse**](BaseResponse.md)
|
112
|
+
|
113
|
+
### Authorization
|
114
|
+
|
115
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
116
|
+
|
117
|
+
### HTTP request headers
|
118
|
+
|
119
|
+
- **Content-Type**: application/json; charset=UTF-8
|
120
|
+
- **Accept**: application/json
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
# **get_payments_configuration**
|
125
|
+
> PaymentsConfiguration get_payments_configuration
|
126
|
+
|
127
|
+
Retrieve payments configuration
|
128
|
+
|
129
|
+
Retrieves payments configuration for this account.
|
130
|
+
|
131
|
+
### Example
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'ultracart_api'
|
135
|
+
|
136
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
137
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
138
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
begin
|
143
|
+
#Retrieve payments configuration
|
144
|
+
result = api_instance.get_payments_configuration
|
145
|
+
p result
|
146
|
+
rescue UltracartClient::ApiError => e
|
147
|
+
puts "Exception when calling ConfigurationApi->get_payments_configuration: #{e}"
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
### Parameters
|
152
|
+
This endpoint does not need any parameter.
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**PaymentsConfiguration**](PaymentsConfiguration.md)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: application/json
|
165
|
+
- **Accept**: application/json
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
# **get_payments_rotating_gateway**
|
170
|
+
> RotatingTransactionGateway get_payments_rotating_gateway(rtg_oid)
|
171
|
+
|
172
|
+
Retrieve a rotating transaction gateway
|
173
|
+
|
174
|
+
Retrieve a rotating transaction gateway
|
175
|
+
|
176
|
+
### Example
|
177
|
+
```ruby
|
178
|
+
# load the gem
|
179
|
+
require 'ultracart_api'
|
180
|
+
|
181
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
182
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
183
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
184
|
+
|
185
|
+
|
186
|
+
rtg_oid = 56 # Integer | The rtg_oid for the desired record.
|
187
|
+
|
188
|
+
|
189
|
+
begin
|
190
|
+
#Retrieve a rotating transaction gateway
|
191
|
+
result = api_instance.get_payments_rotating_gateway(rtg_oid)
|
192
|
+
p result
|
193
|
+
rescue UltracartClient::ApiError => e
|
194
|
+
puts "Exception when calling ConfigurationApi->get_payments_rotating_gateway: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
### Parameters
|
199
|
+
|
200
|
+
Name | Type | Description | Notes
|
201
|
+
------------- | ------------- | ------------- | -------------
|
202
|
+
**rtg_oid** | **Integer**| The rtg_oid for the desired record. |
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: application/json
|
215
|
+
- **Accept**: application/json
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
# **get_payments_rotating_gateway_by_code**
|
220
|
+
> RotatingTransactionGateway get_payments_rotating_gateway_by_code(code)
|
221
|
+
|
222
|
+
Retrieve a rotating transaction gateway by code
|
223
|
+
|
224
|
+
Retrieve a rotating transaction gateway by code
|
225
|
+
|
226
|
+
### Example
|
227
|
+
```ruby
|
228
|
+
# load the gem
|
229
|
+
require 'ultracart_api'
|
230
|
+
|
231
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
232
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
233
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
234
|
+
|
235
|
+
|
236
|
+
code = 'code_example' # String | The code for the desired rotating transaction gateway.
|
237
|
+
|
238
|
+
|
239
|
+
begin
|
240
|
+
#Retrieve a rotating transaction gateway by code
|
241
|
+
result = api_instance.get_payments_rotating_gateway_by_code(code)
|
242
|
+
p result
|
243
|
+
rescue UltracartClient::ApiError => e
|
244
|
+
puts "Exception when calling ConfigurationApi->get_payments_rotating_gateway_by_code: #{e}"
|
245
|
+
end
|
246
|
+
```
|
247
|
+
|
248
|
+
### Parameters
|
249
|
+
|
250
|
+
Name | Type | Description | Notes
|
251
|
+
------------- | ------------- | ------------- | -------------
|
252
|
+
**code** | **String**| The code for the desired rotating transaction gateway. |
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: application/json
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
# **get_payments_rotating_transaction_gateways**
|
270
|
+
> RotatingTransactionGateway get_payments_rotating_transaction_gateways
|
271
|
+
|
272
|
+
Retrieve a list of rotating transaction gateways
|
273
|
+
|
274
|
+
Retrieve a list of rotating transaction gateways
|
275
|
+
|
276
|
+
### Example
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'ultracart_api'
|
280
|
+
|
281
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
282
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
283
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
begin
|
288
|
+
#Retrieve a list of rotating transaction gateways
|
289
|
+
result = api_instance.get_payments_rotating_transaction_gateways
|
290
|
+
p result
|
291
|
+
rescue UltracartClient::ApiError => e
|
292
|
+
puts "Exception when calling ConfigurationApi->get_payments_rotating_transaction_gateways: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
### Parameters
|
297
|
+
This endpoint does not need any parameter.
|
298
|
+
|
299
|
+
### Return type
|
300
|
+
|
301
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
302
|
+
|
303
|
+
### Authorization
|
304
|
+
|
305
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
306
|
+
|
307
|
+
### HTTP request headers
|
308
|
+
|
309
|
+
- **Content-Type**: application/json
|
310
|
+
- **Accept**: application/json
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
# **get_payments_rtg_summaries**
|
315
|
+
> RotatingTransactionGateway get_payments_rtg_summaries
|
316
|
+
|
317
|
+
Retrieve a summary of rotating transaction gateways
|
318
|
+
|
319
|
+
Retrieve a summary of rotating transaction gateways
|
320
|
+
|
321
|
+
### Example
|
322
|
+
```ruby
|
323
|
+
# load the gem
|
324
|
+
require 'ultracart_api'
|
325
|
+
|
326
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
327
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
328
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
begin
|
333
|
+
#Retrieve a summary of rotating transaction gateways
|
334
|
+
result = api_instance.get_payments_rtg_summaries
|
335
|
+
p result
|
336
|
+
rescue UltracartClient::ApiError => e
|
337
|
+
puts "Exception when calling ConfigurationApi->get_payments_rtg_summaries: #{e}"
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
### Parameters
|
342
|
+
This endpoint does not need any parameter.
|
343
|
+
|
344
|
+
### Return type
|
345
|
+
|
346
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
347
|
+
|
348
|
+
### Authorization
|
349
|
+
|
350
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
351
|
+
|
352
|
+
### HTTP request headers
|
353
|
+
|
354
|
+
- **Content-Type**: application/json
|
355
|
+
- **Accept**: application/json
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
# **get_payments_transaction_gateways**
|
360
|
+
> TransactionGatewaysResponse get_payments_transaction_gateways
|
361
|
+
|
362
|
+
Retrieve a list of transaction gateways
|
363
|
+
|
364
|
+
Retrieve a list of transaction gateways
|
365
|
+
|
366
|
+
### Example
|
367
|
+
```ruby
|
368
|
+
# load the gem
|
369
|
+
require 'ultracart_api'
|
370
|
+
|
371
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
372
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
373
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
begin
|
378
|
+
#Retrieve a list of transaction gateways
|
379
|
+
result = api_instance.get_payments_transaction_gateways
|
380
|
+
p result
|
381
|
+
rescue UltracartClient::ApiError => e
|
382
|
+
puts "Exception when calling ConfigurationApi->get_payments_transaction_gateways: #{e}"
|
383
|
+
end
|
384
|
+
```
|
385
|
+
|
386
|
+
### Parameters
|
387
|
+
This endpoint does not need any parameter.
|
388
|
+
|
389
|
+
### Return type
|
390
|
+
|
391
|
+
[**TransactionGatewaysResponse**](TransactionGatewaysResponse.md)
|
392
|
+
|
393
|
+
### Authorization
|
394
|
+
|
395
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
396
|
+
|
397
|
+
### HTTP request headers
|
398
|
+
|
399
|
+
- **Content-Type**: application/json
|
400
|
+
- **Accept**: application/json
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
# **insert_rotating_transaction_gateway**
|
405
|
+
> RotatingTransactionGateway insert_rotating_transaction_gateway(rotating_transaction_gateway)
|
406
|
+
|
407
|
+
Insert a rotating transaction gateway
|
408
|
+
|
409
|
+
Insert a rotating transaction gateway
|
410
|
+
|
411
|
+
### Example
|
412
|
+
```ruby
|
413
|
+
# load the gem
|
414
|
+
require 'ultracart_api'
|
415
|
+
|
416
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
417
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
418
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
419
|
+
|
420
|
+
|
421
|
+
rotating_transaction_gateway = UltracartClient::RotatingTransactionGateway.new # RotatingTransactionGateway | Rotating transaction gateway
|
422
|
+
|
423
|
+
|
424
|
+
begin
|
425
|
+
#Insert a rotating transaction gateway
|
426
|
+
result = api_instance.insert_rotating_transaction_gateway(rotating_transaction_gateway)
|
427
|
+
p result
|
428
|
+
rescue UltracartClient::ApiError => e
|
429
|
+
puts "Exception when calling ConfigurationApi->insert_rotating_transaction_gateway: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
Name | Type | Description | Notes
|
436
|
+
------------- | ------------- | ------------- | -------------
|
437
|
+
**rotating_transaction_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md)| Rotating transaction gateway |
|
438
|
+
|
439
|
+
### Return type
|
440
|
+
|
441
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
442
|
+
|
443
|
+
### Authorization
|
444
|
+
|
445
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
446
|
+
|
447
|
+
### HTTP request headers
|
448
|
+
|
449
|
+
- **Content-Type**: application/json; charset=UTF-8
|
450
|
+
- **Accept**: application/json
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
# **migrate_to_rotating_transaction_gateway**
|
455
|
+
> RotatingTransactionGateway migrate_to_rotating_transaction_gateway(code)
|
456
|
+
|
457
|
+
Migrate a normal transaction gateway to a rotating transaction gateway
|
458
|
+
|
459
|
+
Migrate a normal transaction gateway to a rotating transaction gateway
|
460
|
+
|
461
|
+
### Example
|
462
|
+
```ruby
|
463
|
+
# load the gem
|
464
|
+
require 'ultracart_api'
|
465
|
+
|
466
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
467
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
468
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
469
|
+
|
470
|
+
|
471
|
+
code = 'code_example' # String | The short code for the new rotating transaction gateway
|
472
|
+
|
473
|
+
|
474
|
+
begin
|
475
|
+
#Migrate a normal transaction gateway to a rotating transaction gateway
|
476
|
+
result = api_instance.migrate_to_rotating_transaction_gateway(code)
|
477
|
+
p result
|
478
|
+
rescue UltracartClient::ApiError => e
|
479
|
+
puts "Exception when calling ConfigurationApi->migrate_to_rotating_transaction_gateway: #{e}"
|
480
|
+
end
|
481
|
+
```
|
482
|
+
|
483
|
+
### Parameters
|
484
|
+
|
485
|
+
Name | Type | Description | Notes
|
486
|
+
------------- | ------------- | ------------- | -------------
|
487
|
+
**code** | **String**| The short code for the new rotating transaction gateway |
|
488
|
+
|
489
|
+
### Return type
|
490
|
+
|
491
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
492
|
+
|
493
|
+
### Authorization
|
494
|
+
|
495
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
496
|
+
|
497
|
+
### HTTP request headers
|
498
|
+
|
499
|
+
- **Content-Type**: application/json; charset=UTF-8
|
500
|
+
- **Accept**: application/json
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
# **stripe_connect**
|
505
|
+
> StripeConnectResponse stripe_connect(rtg_oid)
|
506
|
+
|
507
|
+
Begin the processing of connecting with Stripe
|
508
|
+
|
509
|
+
Begin the processing of connecting with Stripe.
|
510
|
+
|
511
|
+
### Example
|
512
|
+
```ruby
|
513
|
+
# load the gem
|
514
|
+
require 'ultracart_api'
|
515
|
+
|
516
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
517
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
518
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
519
|
+
|
520
|
+
|
521
|
+
rtg_oid = 56 # Integer | The rtg_oid to be connected to stripe.
|
522
|
+
|
523
|
+
|
524
|
+
begin
|
525
|
+
#Begin the processing of connecting with Stripe
|
526
|
+
result = api_instance.stripe_connect(rtg_oid)
|
527
|
+
p result
|
528
|
+
rescue UltracartClient::ApiError => e
|
529
|
+
puts "Exception when calling ConfigurationApi->stripe_connect: #{e}"
|
530
|
+
end
|
531
|
+
```
|
532
|
+
|
533
|
+
### Parameters
|
534
|
+
|
535
|
+
Name | Type | Description | Notes
|
536
|
+
------------- | ------------- | ------------- | -------------
|
537
|
+
**rtg_oid** | **Integer**| The rtg_oid to be connected to stripe. |
|
538
|
+
|
539
|
+
### Return type
|
540
|
+
|
541
|
+
[**StripeConnectResponse**](StripeConnectResponse.md)
|
542
|
+
|
543
|
+
### Authorization
|
544
|
+
|
545
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
546
|
+
|
547
|
+
### HTTP request headers
|
548
|
+
|
549
|
+
- **Content-Type**: application/json; charset=UTF-8
|
550
|
+
- **Accept**: application/json
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
# **update_payments_configuration**
|
555
|
+
> PaymentsConfigurationResponse update_payments_configuration(payments_configuration)
|
556
|
+
|
557
|
+
Updates payments configuration
|
558
|
+
|
559
|
+
Updates payments configuration on the UltraCart account.
|
560
|
+
|
561
|
+
### Example
|
562
|
+
```ruby
|
563
|
+
# load the gem
|
564
|
+
require 'ultracart_api'
|
565
|
+
|
566
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
567
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
568
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
569
|
+
|
570
|
+
|
571
|
+
payments_configuration = UltracartClient::PaymentsConfiguration.new # PaymentsConfiguration | Payments configuration
|
572
|
+
|
573
|
+
|
574
|
+
begin
|
575
|
+
#Updates payments configuration
|
576
|
+
result = api_instance.update_payments_configuration(payments_configuration)
|
577
|
+
p result
|
578
|
+
rescue UltracartClient::ApiError => e
|
579
|
+
puts "Exception when calling ConfigurationApi->update_payments_configuration: #{e}"
|
580
|
+
end
|
581
|
+
```
|
582
|
+
|
583
|
+
### Parameters
|
584
|
+
|
585
|
+
Name | Type | Description | Notes
|
586
|
+
------------- | ------------- | ------------- | -------------
|
587
|
+
**payments_configuration** | [**PaymentsConfiguration**](PaymentsConfiguration.md)| Payments configuration |
|
588
|
+
|
589
|
+
### Return type
|
590
|
+
|
591
|
+
[**PaymentsConfigurationResponse**](PaymentsConfigurationResponse.md)
|
592
|
+
|
593
|
+
### Authorization
|
594
|
+
|
595
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
596
|
+
|
597
|
+
### HTTP request headers
|
598
|
+
|
599
|
+
- **Content-Type**: application/json; charset=UTF-8
|
600
|
+
- **Accept**: application/json
|
601
|
+
|
602
|
+
|
603
|
+
|
604
|
+
# **update_payments_transaction_gateway**
|
605
|
+
> TransactionGatewaysResponse update_payments_transaction_gateway(update_gateway_request)
|
606
|
+
|
607
|
+
Updates payments transaction gateway
|
608
|
+
|
609
|
+
Updates payments transaction gateway on the UltraCart account.
|
610
|
+
|
611
|
+
### Example
|
612
|
+
```ruby
|
613
|
+
# load the gem
|
614
|
+
require 'ultracart_api'
|
615
|
+
|
616
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
617
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
618
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
619
|
+
|
620
|
+
|
621
|
+
update_gateway_request = UltracartClient::TransactionGatewaysRequest.new # TransactionGatewaysRequest | Transaction gateways
|
622
|
+
|
623
|
+
|
624
|
+
begin
|
625
|
+
#Updates payments transaction gateway
|
626
|
+
result = api_instance.update_payments_transaction_gateway(update_gateway_request)
|
627
|
+
p result
|
628
|
+
rescue UltracartClient::ApiError => e
|
629
|
+
puts "Exception when calling ConfigurationApi->update_payments_transaction_gateway: #{e}"
|
630
|
+
end
|
631
|
+
```
|
632
|
+
|
633
|
+
### Parameters
|
634
|
+
|
635
|
+
Name | Type | Description | Notes
|
636
|
+
------------- | ------------- | ------------- | -------------
|
637
|
+
**update_gateway_request** | [**TransactionGatewaysRequest**](TransactionGatewaysRequest.md)| Transaction gateways |
|
638
|
+
|
639
|
+
### Return type
|
640
|
+
|
641
|
+
[**TransactionGatewaysResponse**](TransactionGatewaysResponse.md)
|
642
|
+
|
643
|
+
### Authorization
|
644
|
+
|
645
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
646
|
+
|
647
|
+
### HTTP request headers
|
648
|
+
|
649
|
+
- **Content-Type**: application/json; charset=UTF-8
|
650
|
+
- **Accept**: application/json
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
# **update_rotating_transaction_gateway**
|
655
|
+
> RotatingTransactionGateway update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway)
|
656
|
+
|
657
|
+
Update a rotating transaction gateway
|
658
|
+
|
659
|
+
Update a rotating transaction gateway
|
660
|
+
|
661
|
+
### Example
|
662
|
+
```ruby
|
663
|
+
# load the gem
|
664
|
+
require 'ultracart_api'
|
665
|
+
|
666
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
667
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
668
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
669
|
+
|
670
|
+
|
671
|
+
rtg_oid = 56 # Integer | The rtg_oid to update.
|
672
|
+
|
673
|
+
rotating_transaction_gateway = UltracartClient::RotatingTransactionGateway.new # RotatingTransactionGateway | Rotating transaction gateway
|
674
|
+
|
675
|
+
|
676
|
+
begin
|
677
|
+
#Update a rotating transaction gateway
|
678
|
+
result = api_instance.update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway)
|
679
|
+
p result
|
680
|
+
rescue UltracartClient::ApiError => e
|
681
|
+
puts "Exception when calling ConfigurationApi->update_rotating_transaction_gateway: #{e}"
|
682
|
+
end
|
683
|
+
```
|
684
|
+
|
685
|
+
### Parameters
|
686
|
+
|
687
|
+
Name | Type | Description | Notes
|
688
|
+
------------- | ------------- | ------------- | -------------
|
689
|
+
**rtg_oid** | **Integer**| The rtg_oid to update. |
|
690
|
+
**rotating_transaction_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md)| Rotating transaction gateway |
|
691
|
+
|
692
|
+
### Return type
|
693
|
+
|
694
|
+
[**RotatingTransactionGateway**](RotatingTransactionGateway.md)
|
695
|
+
|
696
|
+
### Authorization
|
697
|
+
|
698
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
699
|
+
|
700
|
+
### HTTP request headers
|
701
|
+
|
702
|
+
- **Content-Type**: application/json; charset=UTF-8
|
703
|
+
- **Accept**: application/json
|
704
|
+
|
705
|
+
|
706
|
+
|
707
|
+
# **wepay_enroll**
|
708
|
+
> PaymentsConfigurationResponse wepay_enroll(wepay_enroll)
|
709
|
+
|
710
|
+
Enroll with WePay
|
711
|
+
|
712
|
+
Enroll with WePay on the UltraCart account.
|
713
|
+
|
714
|
+
### Example
|
715
|
+
```ruby
|
716
|
+
# load the gem
|
717
|
+
require 'ultracart_api'
|
718
|
+
|
719
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
720
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
721
|
+
api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
|
722
|
+
|
723
|
+
|
724
|
+
wepay_enroll = UltracartClient::PaymentsWepayEnroll.new # PaymentsWepayEnroll | Wepay enrollment information
|
725
|
+
|
726
|
+
|
727
|
+
begin
|
728
|
+
#Enroll with WePay
|
729
|
+
result = api_instance.wepay_enroll(wepay_enroll)
|
730
|
+
p result
|
731
|
+
rescue UltracartClient::ApiError => e
|
732
|
+
puts "Exception when calling ConfigurationApi->wepay_enroll: #{e}"
|
733
|
+
end
|
734
|
+
```
|
735
|
+
|
736
|
+
### Parameters
|
737
|
+
|
738
|
+
Name | Type | Description | Notes
|
739
|
+
------------- | ------------- | ------------- | -------------
|
740
|
+
**wepay_enroll** | [**PaymentsWepayEnroll**](PaymentsWepayEnroll.md)| Wepay enrollment information |
|
741
|
+
|
742
|
+
### Return type
|
743
|
+
|
744
|
+
[**PaymentsConfigurationResponse**](PaymentsConfigurationResponse.md)
|
745
|
+
|
746
|
+
### Authorization
|
747
|
+
|
748
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
749
|
+
|
750
|
+
### HTTP request headers
|
751
|
+
|
752
|
+
- **Content-Type**: application/json; charset=UTF-8
|
753
|
+
- **Accept**: application/json
|
754
|
+
|
755
|
+
|
756
|
+
|