ultracart_api 3.10.13 → 3.10.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +53 -96
- data/docs/ChannelPartnerApi.md +51 -0
- data/docs/{DelayAutoOrdersResponse.md → ChannelPartnerEstimateTaxResponse.md} +2 -2
- data/docs/ChargebackApi.md +1 -1
- data/docs/CustomerApi.md +1 -1
- data/docs/EmailDomain.md +1 -0
- data/docs/Mailgun.md +8 -0
- data/docs/OrderApi.md +1 -1
- data/docs/SsoApi.md +2 -2
- data/docs/StorefrontApi.md +101 -0
- data/docs/UserApi.md +2 -2
- data/docs/WebhookApi.md +1 -1
- data/lib/ultracart_api/api/channel_partner_api.rb +55 -0
- data/lib/ultracart_api/api/chargeback_api.rb +1 -1
- data/lib/ultracart_api/api/customer_api.rb +1 -1
- data/lib/ultracart_api/api/order_api.rb +1 -1
- data/lib/ultracart_api/api/sso_api.rb +2 -2
- data/lib/ultracart_api/api/storefront_api.rb +112 -0
- data/lib/ultracart_api/api/user_api.rb +2 -2
- data/lib/ultracart_api/api/webhook_api.rb +1 -1
- data/lib/ultracart_api/models/{stripe_connect_response.rb → channel_partner_estimate_tax_response.rb} +8 -8
- data/lib/ultracart_api/models/email_domain.rb +10 -1
- data/lib/ultracart_api/models/{payments_configuration_cash.rb → mailgun.rb} +8 -18
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -39
- metadata +6 -80
- data/docs/ConfigurationApi.md +0 -756
- data/docs/PaymentsConfiguration.md +0 -24
- data/docs/PaymentsConfigurationAffirm.md +0 -15
- data/docs/PaymentsConfigurationAmazon.md +0 -15
- data/docs/PaymentsConfigurationCOD.md +0 -13
- data/docs/PaymentsConfigurationCash.md +0 -9
- data/docs/PaymentsConfigurationCheck.md +0 -19
- data/docs/PaymentsConfigurationCreditCard.md +0 -17
- data/docs/PaymentsConfigurationCreditCardType.md +0 -18
- data/docs/PaymentsConfigurationEcheck.md +0 -12
- data/docs/PaymentsConfigurationInsurance.md +0 -9
- data/docs/PaymentsConfigurationLoanHero.md +0 -12
- data/docs/PaymentsConfigurationMoneyOrder.md +0 -11
- data/docs/PaymentsConfigurationPayPal.md +0 -36
- data/docs/PaymentsConfigurationPurchaseOrder.md +0 -11
- data/docs/PaymentsConfigurationQuoteRequest.md +0 -10
- data/docs/PaymentsConfigurationResponse.md +0 -12
- data/docs/PaymentsConfigurationRestrictions.md +0 -21
- data/docs/PaymentsConfigurationRestrictionsTheme.md +0 -10
- data/docs/PaymentsConfigurationSezzle.md +0 -15
- data/docs/PaymentsConfigurationTestMethod.md +0 -18
- data/docs/PaymentsConfigurationWePay.md +0 -35
- data/docs/PaymentsConfigurationWireTransfer.md +0 -18
- data/docs/PaymentsThemeTransactionType.md +0 -10
- data/docs/PaymentsWepayEnroll.md +0 -22
- data/docs/RotatingTransactionGateway.md +0 -51
- data/docs/RotatingTransactionGatewayResponse.md +0 -12
- data/docs/RotatingTransactionGatewaysResponse.md +0 -12
- data/docs/RtgCurrency.md +0 -10
- data/docs/RtgDayOfMonthRestriction.md +0 -9
- data/docs/RtgDayOfWeekRestriction.md +0 -10
- data/docs/RtgSummaryGateway.md +0 -24
- data/docs/RtgSummaryResponse.md +0 -14
- data/docs/RtgThemeRestriction.md +0 -10
- data/docs/StripeConnectResponse.md +0 -12
- data/docs/TransactionGateway.md +0 -71
- data/docs/TransactionGatewaysRequest.md +0 -10
- data/docs/TransactionGatewaysResponse.md +0 -12
- data/lib/ultracart_api/api/configuration_api.rb +0 -843
- data/lib/ultracart_api/models/delay_auto_orders_response.rb +0 -221
- data/lib/ultracart_api/models/payments_configuration.rb +0 -329
- data/lib/ultracart_api/models/payments_configuration_affirm.rb +0 -288
- data/lib/ultracart_api/models/payments_configuration_amazon.rb +0 -288
- data/lib/ultracart_api/models/payments_configuration_check.rb +0 -294
- data/lib/ultracart_api/models/payments_configuration_cod.rb +0 -234
- data/lib/ultracart_api/models/payments_configuration_credit_card.rb +0 -279
- data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb +0 -318
- data/lib/ultracart_api/models/payments_configuration_echeck.rb +0 -226
- data/lib/ultracart_api/models/payments_configuration_insurance.rb +0 -194
- data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +0 -224
- data/lib/ultracart_api/models/payments_configuration_money_order.rb +0 -214
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +0 -534
- data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +0 -214
- data/lib/ultracart_api/models/payments_configuration_quote_request.rb +0 -204
- data/lib/ultracart_api/models/payments_configuration_response.rb +0 -221
- data/lib/ultracart_api/models/payments_configuration_restrictions.rb +0 -447
- data/lib/ultracart_api/models/payments_configuration_restrictions_theme.rb +0 -202
- data/lib/ultracart_api/models/payments_configuration_sezzle.rb +0 -288
- data/lib/ultracart_api/models/payments_configuration_test_method.rb +0 -319
- data/lib/ultracart_api/models/payments_configuration_we_pay.rb +0 -454
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +0 -284
- data/lib/ultracart_api/models/payments_theme_transaction_type.rb +0 -239
- data/lib/ultracart_api/models/payments_wepay_enroll.rb +0 -310
- data/lib/ultracart_api/models/rotating_transaction_gateway.rb +0 -675
- data/lib/ultracart_api/models/rotating_transaction_gateway_response.rb +0 -221
- data/lib/ultracart_api/models/rotating_transaction_gateways_response.rb +0 -223
- data/lib/ultracart_api/models/rtg_currency.rb +0 -205
- data/lib/ultracart_api/models/rtg_day_of_month_restriction.rb +0 -195
- data/lib/ultracart_api/models/rtg_day_of_week_restriction.rb +0 -205
- data/lib/ultracart_api/models/rtg_summary_gateway.rb +0 -329
- data/lib/ultracart_api/models/rtg_summary_response.rb +0 -240
- data/lib/ultracart_api/models/rtg_theme_restriction.rb +0 -239
- data/lib/ultracart_api/models/transaction_gateway.rb +0 -823
- data/lib/ultracart_api/models/transaction_gateways_request.rb +0 -242
- data/lib/ultracart_api/models/transaction_gateways_response.rb +0 -223
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f37680929be7f700802faf7c672a24debc1194e6c4541025e158f38a84048fa9
|
|
4
|
+
data.tar.gz: 5e83ffd30822f714eda188689478e0e3e32f91e993add0eb7b287cbe6b2c5431
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a7ad9001ea6e6bed8ffae58a7ea2ad07d7b4b479f8bb2e7c8ce78209c00d94135a5f0886221126ece44383e6626cdcfcbd8051207b8798ebecf42fdff6ae311
|
|
7
|
+
data.tar.gz: 55b3decb2da6580d62fccb1c064a98f0910b50a4b4ed3e88bf61a8b558eade9b5a5977ee6f198a42d64887f6dd8198ee6d20e7dba9eb8a17045e3432d890cf30
|
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.
|
|
10
|
+
- Package version: 3.10.18
|
|
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.10.
|
|
27
|
+
gem install ./ultracart_api-3.10.18.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.18.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.10.
|
|
35
|
+
gem 'ultracart_api', '~> 3.10.18'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -99,6 +99,7 @@ Class | Method | HTTP request | Description
|
|
|
99
99
|
*UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
|
|
100
100
|
*UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
|
|
101
101
|
*UltracartClient::ChannelPartnerApi* | [**estimate_shipping_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
|
|
102
|
+
*UltracartClient::ChannelPartnerApi* | [**estimate_tax_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
|
|
102
103
|
*UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
|
|
103
104
|
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
|
104
105
|
*UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
|
|
@@ -124,21 +125,6 @@ Class | Method | HTTP request | Description
|
|
|
124
125
|
*UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
|
125
126
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
|
126
127
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
127
|
-
*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
|
|
128
|
-
*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
|
|
129
|
-
*UltracartClient::ConfigurationApi* | [**get_payments_configuration**](docs/ConfigurationApi.md#get_payments_configuration) | **GET** /configuration/checkout/payments | Retrieve payments configuration
|
|
130
|
-
*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
|
|
131
|
-
*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
|
|
132
|
-
*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
|
|
133
|
-
*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
|
|
134
|
-
*UltracartClient::ConfigurationApi* | [**get_payments_transaction_gateways**](docs/ConfigurationApi.md#get_payments_transaction_gateways) | **GET** /configuration/checkout/payments/tg | Retrieve a list of transaction gateways
|
|
135
|
-
*UltracartClient::ConfigurationApi* | [**insert_rotating_transaction_gateway**](docs/ConfigurationApi.md#insert_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/rtg/ | Insert a rotating transaction gateway
|
|
136
|
-
*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
|
|
137
|
-
*UltracartClient::ConfigurationApi* | [**stripe_connect**](docs/ConfigurationApi.md#stripe_connect) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect | Begin the processing of connecting with Stripe
|
|
138
|
-
*UltracartClient::ConfigurationApi* | [**update_payments_configuration**](docs/ConfigurationApi.md#update_payments_configuration) | **PUT** /configuration/checkout/payments | Updates payments configuration
|
|
139
|
-
*UltracartClient::ConfigurationApi* | [**update_payments_transaction_gateway**](docs/ConfigurationApi.md#update_payments_transaction_gateway) | **PUT** /configuration/checkout/payments/tg | Updates payments transaction gateway
|
|
140
|
-
*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
|
|
141
|
-
*UltracartClient::ConfigurationApi* | [**wepay_enroll**](docs/ConfigurationApi.md#wepay_enroll) | **PUT** /configuration/checkout/wepayEnroll | Enroll with WePay
|
|
142
128
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
143
129
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
|
144
130
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
|
@@ -241,6 +227,7 @@ Class | Method | HTTP request | Description
|
|
|
241
227
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
|
242
228
|
*UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
|
243
229
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
|
230
|
+
*UltracartClient::StorefrontApi* | [**create_email_sending_domain2**](docs/StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
|
|
244
231
|
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
|
245
232
|
*UltracartClient::StorefrontApi* | [**delete_email_campaign_folder**](docs/StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
|
|
246
233
|
*UltracartClient::StorefrontApi* | [**delete_email_commseq_stat**](docs/StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
|
|
@@ -383,6 +370,7 @@ Class | Method | HTTP request | Description
|
|
|
383
370
|
*UltracartClient::StorefrontApi* | [**update_email_plan**](docs/StorefrontApi.md#update_email_plan) | **POST** /storefront/{storefront_oid}/email/plan | Update email plan
|
|
384
371
|
*UltracartClient::StorefrontApi* | [**update_email_postcard**](docs/StorefrontApi.md#update_email_postcard) | **PUT** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Update email postcard
|
|
385
372
|
*UltracartClient::StorefrontApi* | [**update_email_segment**](docs/StorefrontApi.md#update_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Update email segment
|
|
373
|
+
*UltracartClient::StorefrontApi* | [**update_email_sending_domain**](docs/StorefrontApi.md#update_email_sending_domain) | **PUT** /storefront/email/sending_domains/{domain} | Update email sending domain
|
|
386
374
|
*UltracartClient::StorefrontApi* | [**update_email_settings**](docs/StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
|
|
387
375
|
*UltracartClient::StorefrontApi* | [**update_experiment**](docs/StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
|
|
388
376
|
*UltracartClient::StorefrontApi* | [**update_library_item**](docs/StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
|
|
@@ -541,6 +529,7 @@ Class | Method | HTTP request | Description
|
|
|
541
529
|
- [UltracartClient::CartValidationResponse](docs/CartValidationResponse.md)
|
|
542
530
|
- [UltracartClient::ChannelPartnerCancelResponse](docs/ChannelPartnerCancelResponse.md)
|
|
543
531
|
- [UltracartClient::ChannelPartnerEstimateShippingResponse](docs/ChannelPartnerEstimateShippingResponse.md)
|
|
532
|
+
- [UltracartClient::ChannelPartnerEstimateTaxResponse](docs/ChannelPartnerEstimateTaxResponse.md)
|
|
544
533
|
- [UltracartClient::ChannelPartnerImportResponse](docs/ChannelPartnerImportResponse.md)
|
|
545
534
|
- [UltracartClient::ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
|
|
546
535
|
- [UltracartClient::ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
|
|
@@ -653,7 +642,6 @@ Class | Method | HTTP request | Description
|
|
|
653
642
|
- [UltracartClient::CustomerTaxCodes](docs/CustomerTaxCodes.md)
|
|
654
643
|
- [UltracartClient::CustomersResponse](docs/CustomersResponse.md)
|
|
655
644
|
- [UltracartClient::DataTablesServerSideResponse](docs/DataTablesServerSideResponse.md)
|
|
656
|
-
- [UltracartClient::DelayAutoOrdersResponse](docs/DelayAutoOrdersResponse.md)
|
|
657
645
|
- [UltracartClient::Distance](docs/Distance.md)
|
|
658
646
|
- [UltracartClient::DistributionCenter](docs/DistributionCenter.md)
|
|
659
647
|
- [UltracartClient::DistributionCentersResponse](docs/DistributionCentersResponse.md)
|
|
@@ -891,6 +879,7 @@ Class | Method | HTTP request | Description
|
|
|
891
879
|
- [UltracartClient::ListSegmentMembership](docs/ListSegmentMembership.md)
|
|
892
880
|
- [UltracartClient::LookupRequest](docs/LookupRequest.md)
|
|
893
881
|
- [UltracartClient::LookupResponse](docs/LookupResponse.md)
|
|
882
|
+
- [UltracartClient::Mailgun](docs/Mailgun.md)
|
|
894
883
|
- [UltracartClient::Metric](docs/Metric.md)
|
|
895
884
|
- [UltracartClient::Notification](docs/Notification.md)
|
|
896
885
|
- [UltracartClient::OauthRevokeSuccessResponse](docs/OauthRevokeSuccessResponse.md)
|
|
@@ -952,30 +941,6 @@ Class | Method | HTTP request | Description
|
|
|
952
941
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
|
953
942
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
|
954
943
|
- [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
|
|
955
|
-
- [UltracartClient::PaymentsConfiguration](docs/PaymentsConfiguration.md)
|
|
956
|
-
- [UltracartClient::PaymentsConfigurationAffirm](docs/PaymentsConfigurationAffirm.md)
|
|
957
|
-
- [UltracartClient::PaymentsConfigurationAmazon](docs/PaymentsConfigurationAmazon.md)
|
|
958
|
-
- [UltracartClient::PaymentsConfigurationCOD](docs/PaymentsConfigurationCOD.md)
|
|
959
|
-
- [UltracartClient::PaymentsConfigurationCash](docs/PaymentsConfigurationCash.md)
|
|
960
|
-
- [UltracartClient::PaymentsConfigurationCheck](docs/PaymentsConfigurationCheck.md)
|
|
961
|
-
- [UltracartClient::PaymentsConfigurationCreditCard](docs/PaymentsConfigurationCreditCard.md)
|
|
962
|
-
- [UltracartClient::PaymentsConfigurationCreditCardType](docs/PaymentsConfigurationCreditCardType.md)
|
|
963
|
-
- [UltracartClient::PaymentsConfigurationEcheck](docs/PaymentsConfigurationEcheck.md)
|
|
964
|
-
- [UltracartClient::PaymentsConfigurationInsurance](docs/PaymentsConfigurationInsurance.md)
|
|
965
|
-
- [UltracartClient::PaymentsConfigurationLoanHero](docs/PaymentsConfigurationLoanHero.md)
|
|
966
|
-
- [UltracartClient::PaymentsConfigurationMoneyOrder](docs/PaymentsConfigurationMoneyOrder.md)
|
|
967
|
-
- [UltracartClient::PaymentsConfigurationPayPal](docs/PaymentsConfigurationPayPal.md)
|
|
968
|
-
- [UltracartClient::PaymentsConfigurationPurchaseOrder](docs/PaymentsConfigurationPurchaseOrder.md)
|
|
969
|
-
- [UltracartClient::PaymentsConfigurationQuoteRequest](docs/PaymentsConfigurationQuoteRequest.md)
|
|
970
|
-
- [UltracartClient::PaymentsConfigurationResponse](docs/PaymentsConfigurationResponse.md)
|
|
971
|
-
- [UltracartClient::PaymentsConfigurationRestrictions](docs/PaymentsConfigurationRestrictions.md)
|
|
972
|
-
- [UltracartClient::PaymentsConfigurationRestrictionsTheme](docs/PaymentsConfigurationRestrictionsTheme.md)
|
|
973
|
-
- [UltracartClient::PaymentsConfigurationSezzle](docs/PaymentsConfigurationSezzle.md)
|
|
974
|
-
- [UltracartClient::PaymentsConfigurationTestMethod](docs/PaymentsConfigurationTestMethod.md)
|
|
975
|
-
- [UltracartClient::PaymentsConfigurationWePay](docs/PaymentsConfigurationWePay.md)
|
|
976
|
-
- [UltracartClient::PaymentsConfigurationWireTransfer](docs/PaymentsConfigurationWireTransfer.md)
|
|
977
|
-
- [UltracartClient::PaymentsThemeTransactionType](docs/PaymentsThemeTransactionType.md)
|
|
978
|
-
- [UltracartClient::PaymentsWepayEnroll](docs/PaymentsWepayEnroll.md)
|
|
979
944
|
- [UltracartClient::Permission](docs/Permission.md)
|
|
980
945
|
- [UltracartClient::PricingTier](docs/PricingTier.md)
|
|
981
946
|
- [UltracartClient::PricingTierNotification](docs/PricingTierNotification.md)
|
|
@@ -986,15 +951,6 @@ Class | Method | HTTP request | Description
|
|
|
986
951
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
|
987
952
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
|
988
953
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
|
989
|
-
- [UltracartClient::RotatingTransactionGateway](docs/RotatingTransactionGateway.md)
|
|
990
|
-
- [UltracartClient::RotatingTransactionGatewayResponse](docs/RotatingTransactionGatewayResponse.md)
|
|
991
|
-
- [UltracartClient::RotatingTransactionGatewaysResponse](docs/RotatingTransactionGatewaysResponse.md)
|
|
992
|
-
- [UltracartClient::RtgCurrency](docs/RtgCurrency.md)
|
|
993
|
-
- [UltracartClient::RtgDayOfMonthRestriction](docs/RtgDayOfMonthRestriction.md)
|
|
994
|
-
- [UltracartClient::RtgDayOfWeekRestriction](docs/RtgDayOfWeekRestriction.md)
|
|
995
|
-
- [UltracartClient::RtgSummaryGateway](docs/RtgSummaryGateway.md)
|
|
996
|
-
- [UltracartClient::RtgSummaryResponse](docs/RtgSummaryResponse.md)
|
|
997
|
-
- [UltracartClient::RtgThemeRestriction](docs/RtgThemeRestriction.md)
|
|
998
954
|
- [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
|
|
999
955
|
- [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
|
|
1000
956
|
- [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
|
|
@@ -1053,7 +1009,6 @@ Class | Method | HTTP request | Description
|
|
|
1053
1009
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
|
1054
1010
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
|
1055
1011
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
|
1056
|
-
- [UltracartClient::StripeConnectResponse](docs/StripeConnectResponse.md)
|
|
1057
1012
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
|
1058
1013
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
|
1059
1014
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
|
@@ -1083,9 +1038,6 @@ Class | Method | HTTP request | Description
|
|
|
1083
1038
|
- [UltracartClient::TransactionEmailListResponse](docs/TransactionEmailListResponse.md)
|
|
1084
1039
|
- [UltracartClient::TransactionEmailOption](docs/TransactionEmailOption.md)
|
|
1085
1040
|
- [UltracartClient::TransactionEmailResponse](docs/TransactionEmailResponse.md)
|
|
1086
|
-
- [UltracartClient::TransactionGateway](docs/TransactionGateway.md)
|
|
1087
|
-
- [UltracartClient::TransactionGatewaysRequest](docs/TransactionGatewaysRequest.md)
|
|
1088
|
-
- [UltracartClient::TransactionGatewaysResponse](docs/TransactionGatewaysResponse.md)
|
|
1089
1041
|
- [UltracartClient::Twilio](docs/Twilio.md)
|
|
1090
1042
|
- [UltracartClient::TwilioResponse](docs/TwilioResponse.md)
|
|
1091
1043
|
- [UltracartClient::TwiliosResponse](docs/TwiliosResponse.md)
|
|
@@ -1179,45 +1131,50 @@ Class | Method | HTTP request | Description
|
|
|
1179
1131
|
Not every change is committed to every SDK.
|
|
1180
1132
|
|
|
1181
1133
|
| Version | Date | Comments |
|
|
1182
|
-
| --: | :-: | --- |
|
|
1183
|
-
| 3.10.
|
|
1184
|
-
| 3.10.
|
|
1185
|
-
| 3.10.
|
|
1186
|
-
| 3.10.
|
|
1187
|
-
| 3.10.
|
|
1188
|
-
| 3.10.
|
|
1189
|
-
| 3.10.
|
|
1190
|
-
| 3.10.
|
|
1191
|
-
| 3.10.
|
|
1192
|
-
| 3.10.
|
|
1193
|
-
| 3.10.
|
|
1194
|
-
| 3.10.
|
|
1195
|
-
| 3.10.
|
|
1196
|
-
| 3.10.
|
|
1197
|
-
| 3.
|
|
1198
|
-
| 3.
|
|
1199
|
-
| 3.
|
|
1200
|
-
| 3.
|
|
1201
|
-
| 3.
|
|
1202
|
-
| 3.9.
|
|
1203
|
-
| 3.9.
|
|
1204
|
-
| 3.9.
|
|
1205
|
-
| 3.9.
|
|
1206
|
-
| 3.
|
|
1207
|
-
| 3.
|
|
1208
|
-
| 3.
|
|
1209
|
-
| 3.
|
|
1210
|
-
| 3.
|
|
1211
|
-
| 3.8.
|
|
1212
|
-
| 3.8.
|
|
1213
|
-
| 3.
|
|
1214
|
-
| 3.
|
|
1215
|
-
| 3.
|
|
1216
|
-
| 3.
|
|
1217
|
-
| 3.
|
|
1218
|
-
| 3.
|
|
1219
|
-
| 3.6.
|
|
1220
|
-
| 3.6.
|
|
1134
|
+
| --: | :-: | --- |
|
|
1135
|
+
| 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
|
1136
|
+
| 3.10.17 | 06/23/2022 | automation test |
|
|
1137
|
+
| 3.10.16 | 06/23/2022 | automation test |
|
|
1138
|
+
| 3.10.15 | 06/21/2022 | ChannelPartnerApi.estimateShipping |
|
|
1139
|
+
| 3.10.14 | 06/16/2022 | added createEmailSendingDomain2 to support additional MTAs |
|
|
1140
|
+
| 3.10.13 | 06/16/2022 | renamed latest method to avoid conflict between customer profile search and storefront search |
|
|
1141
|
+
| 3.10.12 | 06/16/2022 | Customer profile search method to look up tags |
|
|
1142
|
+
| 3.10.11 | 06/10/2022 | esp segment 3rd party sync add/remove tag fields |
|
|
1143
|
+
| 3.10.10 | 06/06/2022 | storefront communication options for syncing to third party provider list |
|
|
1144
|
+
| 3.10.9 | 06/01/2022 | bug fixes for customer profile store credit |
|
|
1145
|
+
| 3.10.8 | 05/27/2022 | customer store credit |
|
|
1146
|
+
| 3.10.7 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
|
|
1147
|
+
| 3.10.6 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
|
|
1148
|
+
| 3.10.5 | 05/20/2022 | dependabot on java gson version |
|
|
1149
|
+
| 3.10.4 | 05/20/2022 | dependabot on java gson |
|
|
1150
|
+
| 3.10.3 | 05/20/2022 | OrderApi.generatePackingSkip calls had wrong return type |
|
|
1151
|
+
| 3.10.2 | 05/12/2022 | ChannelPartnerApi renamed one of the delete methods |
|
|
1152
|
+
| 3.10.1 | 05/12/2022 | ChannelPartnerApi added orderId to import response obj |
|
|
1153
|
+
| 3.10.0 | 05/10/2022 | beta release of ChannelPartnerApi |
|
|
1154
|
+
| 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
|
|
1155
|
+
| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
|
|
1156
|
+
| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
|
|
1157
|
+
| 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
|
|
1158
|
+
| 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
|
|
1159
|
+
| 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
|
|
1160
|
+
| 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
|
|
1161
|
+
| 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
|
|
1162
|
+
| 3.9.0 | 03/03/2022 | removed ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
|
|
1163
|
+
| 3.8.8 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
|
|
1164
|
+
| 3.8.7 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
|
|
1165
|
+
| 3.8.6 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
|
|
1166
|
+
| 3.8.5 | 02/25/2022 | new coupon for fixed cost shipping method |
|
|
1167
|
+
| 3.8.2 | 02/16/2022 | create gift certificate method was missing email |
|
|
1168
|
+
| 3.8.1 | 02/16/2022 | auto order item level pause flag |
|
|
1169
|
+
| 3.8.0 | 02/16/2022 | gift certificate api (testing) |
|
|
1170
|
+
| 3.7.38 | 02/15/2022 | gift certificate api (currently in testing) |
|
|
1171
|
+
| 3.6.38 | 02/07/2022 | Exposed auto order logs |
|
|
1172
|
+
| 3.6.37 | 02/04/2022 | insurance type for insurance payments |
|
|
1173
|
+
| 3.6.36 | 12/29/2021 | Mail actual post card flag added to test method |
|
|
1174
|
+
| 3.6.35 | 12/14/2021 | Add cancel_auto_order option to the accounts receivable retry configuration |
|
|
1175
|
+
| 3.6.34 | 12/14/2021 | add evening phone E.164 fields to order billing/shipping objects |
|
|
1176
|
+
| 3.6.33 | 12/13/2021 | automation testing |
|
|
1177
|
+
| 3.6.32 | 12/10/2021 | testing automation - message 4 |
|
|
1221
1178
|
| 3.6.25 | 12/06/2021 | sdk automation testing. no changes to actual sdk |
|
|
1222
1179
|
| 3.6.24 | 11/30/2021 | return items_invalid_for_coupons for CouponResponse object to drive UI warnings |
|
|
1223
1180
|
| 3.6.23 | 11/29/2021 | Item auto order prohibit cards that expire in months setting. |
|
data/docs/ChannelPartnerApi.md
CHANGED
|
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**cancel_order_by_channel_partner_order_id**](ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
|
|
8
8
|
[**cancel_order_by_ultra_cart_order_id**](ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
|
|
9
9
|
[**estimate_shipping_for_channel_partner_order**](ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
|
|
10
|
+
[**estimate_tax_for_channel_partner_order**](ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
|
|
10
11
|
[**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
|
|
11
12
|
|
|
12
13
|
|
|
@@ -160,6 +161,56 @@ Name | Type | Description | Notes
|
|
|
160
161
|
|
|
161
162
|
|
|
162
163
|
|
|
164
|
+
# **estimate_tax_for_channel_partner_order**
|
|
165
|
+
> ChannelPartnerEstimateTaxResponse estimate_tax_for_channel_partner_order(channel_partner_order)
|
|
166
|
+
|
|
167
|
+
Estimate tax for channel partner order
|
|
168
|
+
|
|
169
|
+
Estimate tax for order from a channel partner.
|
|
170
|
+
|
|
171
|
+
### Example
|
|
172
|
+
```ruby
|
|
173
|
+
# load the gem
|
|
174
|
+
require 'ultracart_api'
|
|
175
|
+
|
|
176
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
177
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
178
|
+
api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing tax estimate
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
begin
|
|
185
|
+
#Estimate tax for channel partner order
|
|
186
|
+
result = api_instance.estimate_tax_for_channel_partner_order(channel_partner_order)
|
|
187
|
+
p result
|
|
188
|
+
rescue UltracartClient::ApiError => e
|
|
189
|
+
puts "Exception when calling ChannelPartnerApi->estimate_tax_for_channel_partner_order: #{e}"
|
|
190
|
+
end
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
Name | Type | Description | Notes
|
|
196
|
+
------------- | ------------- | ------------- | -------------
|
|
197
|
+
**channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order needing tax estimate |
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
[**ChannelPartnerEstimateTaxResponse**](ChannelPartnerEstimateTaxResponse.md)
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
163
214
|
# **import_channel_partner_order**
|
|
164
215
|
> ChannelPartnerImportResponse import_channel_partner_order(channel_partner_order)
|
|
165
216
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# UltracartClient::
|
|
1
|
+
# UltracartClient::ChannelPartnerEstimateTaxResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**arbitrary_tax** | **Float** | | [optional]
|
|
6
7
|
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
-
**message** | **String** | | [optional]
|
|
8
8
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
9
|
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
10
|
**warning** | [**Warning**](Warning.md) | | [optional]
|
data/docs/ChargebackApi.md
CHANGED
data/docs/CustomerApi.md
CHANGED
data/docs/EmailDomain.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**domain** | **String** | | [optional]
|
|
10
10
|
**esp_domain_uuid** | **String** | | [optional]
|
|
11
11
|
**identity_status** | **String** | | [optional]
|
|
12
|
+
**mailgun** | [**Mailgun**](Mailgun.md) | | [optional]
|
|
12
13
|
**merchant_id** | **String** | | [optional]
|
|
13
14
|
**provider** | **String** | | [optional]
|
|
14
15
|
**spf** | [**VerificationRecord**](VerificationRecord.md) | | [optional]
|
data/docs/Mailgun.md
ADDED
data/docs/OrderApi.md
CHANGED
data/docs/SsoApi.md
CHANGED
|
@@ -50,7 +50,7 @@ This endpoint does not need any parameter.
|
|
|
50
50
|
|
|
51
51
|
### HTTP request headers
|
|
52
52
|
|
|
53
|
-
- **Content-Type**: application/json
|
|
53
|
+
- **Content-Type**: application/json
|
|
54
54
|
- **Accept**: application/json
|
|
55
55
|
|
|
56
56
|
|
|
@@ -144,7 +144,7 @@ nil (empty response body)
|
|
|
144
144
|
|
|
145
145
|
### HTTP request headers
|
|
146
146
|
|
|
147
|
-
- **Content-Type**: application/json
|
|
147
|
+
- **Content-Type**: application/json
|
|
148
148
|
- **Accept**: application/json
|
|
149
149
|
|
|
150
150
|
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -13,6 +13,7 @@ Method | HTTP request | Description
|
|
|
13
13
|
[**clone_email_campaign**](StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
|
14
14
|
[**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
|
15
15
|
[**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
|
16
|
+
[**create_email_sending_domain2**](StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
|
|
16
17
|
[**create_twilio_account**](StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
|
17
18
|
[**delete_email_campaign_folder**](StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
|
|
18
19
|
[**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
|
|
@@ -155,6 +156,7 @@ Method | HTTP request | Description
|
|
|
155
156
|
[**update_email_plan**](StorefrontApi.md#update_email_plan) | **POST** /storefront/{storefront_oid}/email/plan | Update email plan
|
|
156
157
|
[**update_email_postcard**](StorefrontApi.md#update_email_postcard) | **PUT** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Update email postcard
|
|
157
158
|
[**update_email_segment**](StorefrontApi.md#update_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Update email segment
|
|
159
|
+
[**update_email_sending_domain**](StorefrontApi.md#update_email_sending_domain) | **PUT** /storefront/email/sending_domains/{domain} | Update email sending domain
|
|
158
160
|
[**update_email_settings**](StorefrontApi.md#update_email_settings) | **POST** /storefront/{storefront_oid}/email/settings | Update email settings
|
|
159
161
|
[**update_experiment**](StorefrontApi.md#update_experiment) | **PUT** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Update experiment
|
|
160
162
|
[**update_library_item**](StorefrontApi.md#update_library_item) | **PUT** /storefront/code_library/{library_item_oid} | Update library item. Note that only certain fields may be updated via this method.
|
|
@@ -630,6 +632,54 @@ Name | Type | Description | Notes
|
|
|
630
632
|
|
|
631
633
|
|
|
632
634
|
|
|
635
|
+
# **create_email_sending_domain2**
|
|
636
|
+
> EmailSendingDomainResponse create_email_sending_domain2(email_domain)
|
|
637
|
+
|
|
638
|
+
Create email sending domain for various providers
|
|
639
|
+
|
|
640
|
+
### Example
|
|
641
|
+
```ruby
|
|
642
|
+
# load the gem
|
|
643
|
+
require 'ultracart_api'
|
|
644
|
+
|
|
645
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
646
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
647
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
email_domain = UltracartClient::EmailDomain.new # EmailDomain | EmailDomain
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
begin
|
|
654
|
+
#Create email sending domain for various providers
|
|
655
|
+
result = api_instance.create_email_sending_domain2(email_domain)
|
|
656
|
+
p result
|
|
657
|
+
rescue UltracartClient::ApiError => e
|
|
658
|
+
puts "Exception when calling StorefrontApi->create_email_sending_domain2: #{e}"
|
|
659
|
+
end
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
### Parameters
|
|
663
|
+
|
|
664
|
+
Name | Type | Description | Notes
|
|
665
|
+
------------- | ------------- | ------------- | -------------
|
|
666
|
+
**email_domain** | [**EmailDomain**](EmailDomain.md)| EmailDomain |
|
|
667
|
+
|
|
668
|
+
### Return type
|
|
669
|
+
|
|
670
|
+
[**EmailSendingDomainResponse**](EmailSendingDomainResponse.md)
|
|
671
|
+
|
|
672
|
+
### Authorization
|
|
673
|
+
|
|
674
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
675
|
+
|
|
676
|
+
### HTTP request headers
|
|
677
|
+
|
|
678
|
+
- **Content-Type**: application/json
|
|
679
|
+
- **Accept**: application/json
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
633
683
|
# **create_twilio_account**
|
|
634
684
|
> TwilioResponse create_twilio_account(twilio)
|
|
635
685
|
|
|
@@ -7944,6 +7994,57 @@ Name | Type | Description | Notes
|
|
|
7944
7994
|
|
|
7945
7995
|
|
|
7946
7996
|
|
|
7997
|
+
# **update_email_sending_domain**
|
|
7998
|
+
> EmailSendingDomainResponse update_email_sending_domain(domain, email_domain)
|
|
7999
|
+
|
|
8000
|
+
Update email sending domain
|
|
8001
|
+
|
|
8002
|
+
### Example
|
|
8003
|
+
```ruby
|
|
8004
|
+
# load the gem
|
|
8005
|
+
require 'ultracart_api'
|
|
8006
|
+
|
|
8007
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
8008
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
8009
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
8010
|
+
|
|
8011
|
+
|
|
8012
|
+
domain = 'domain_example' # String |
|
|
8013
|
+
|
|
8014
|
+
email_domain = UltracartClient::EmailDomain.new # EmailDomain | EmailDomain
|
|
8015
|
+
|
|
8016
|
+
|
|
8017
|
+
begin
|
|
8018
|
+
#Update email sending domain
|
|
8019
|
+
result = api_instance.update_email_sending_domain(domain, email_domain)
|
|
8020
|
+
p result
|
|
8021
|
+
rescue UltracartClient::ApiError => e
|
|
8022
|
+
puts "Exception when calling StorefrontApi->update_email_sending_domain: #{e}"
|
|
8023
|
+
end
|
|
8024
|
+
```
|
|
8025
|
+
|
|
8026
|
+
### Parameters
|
|
8027
|
+
|
|
8028
|
+
Name | Type | Description | Notes
|
|
8029
|
+
------------- | ------------- | ------------- | -------------
|
|
8030
|
+
**domain** | **String**| |
|
|
8031
|
+
**email_domain** | [**EmailDomain**](EmailDomain.md)| EmailDomain |
|
|
8032
|
+
|
|
8033
|
+
### Return type
|
|
8034
|
+
|
|
8035
|
+
[**EmailSendingDomainResponse**](EmailSendingDomainResponse.md)
|
|
8036
|
+
|
|
8037
|
+
### Authorization
|
|
8038
|
+
|
|
8039
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8040
|
+
|
|
8041
|
+
### HTTP request headers
|
|
8042
|
+
|
|
8043
|
+
- **Content-Type**: application/json
|
|
8044
|
+
- **Accept**: application/json
|
|
8045
|
+
|
|
8046
|
+
|
|
8047
|
+
|
|
7947
8048
|
# **update_email_settings**
|
|
7948
8049
|
> EmailSettingsResponse update_email_settings(storefront_oid, settings)
|
|
7949
8050
|
|
data/docs/UserApi.md
CHANGED
|
@@ -61,7 +61,7 @@ nil (empty response body)
|
|
|
61
61
|
|
|
62
62
|
### HTTP request headers
|
|
63
63
|
|
|
64
|
-
- **Content-Type**: application/json
|
|
64
|
+
- **Content-Type**: application/json
|
|
65
65
|
- **Accept**: application/json
|
|
66
66
|
|
|
67
67
|
|
|
@@ -110,7 +110,7 @@ nil (empty response body)
|
|
|
110
110
|
|
|
111
111
|
### HTTP request headers
|
|
112
112
|
|
|
113
|
-
- **Content-Type**: application/json
|
|
113
|
+
- **Content-Type**: application/json
|
|
114
114
|
- **Accept**: application/json
|
|
115
115
|
|
|
116
116
|
|