ultracart_api 4.1.203 → 4.1.205

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.
data/docs/SfvbApi.md CHANGED
@@ -16,6 +16,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
16
16
  | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
17
17
  | [**delete_sfvb_approval**](SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request |
18
18
  | [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
19
+ | [**delete_sfvb_comms_sending_domain**](SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain |
20
+ | [**delete_sfvb_comms_twilio_account**](SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account |
19
21
  | [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
20
22
  | [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
21
23
  | [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
@@ -47,6 +49,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
47
49
  | [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
48
50
  | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
49
51
  | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
52
+ | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
53
+ | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
54
+ | [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
50
55
  | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
51
56
  | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
52
57
  | [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
@@ -92,6 +97,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
92
97
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
93
98
  | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
94
99
  | [**get_sfvb_theme_job**](SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job |
100
+ | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
95
101
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
96
102
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
97
103
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
@@ -100,6 +106,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
100
106
  | [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
101
107
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
102
108
  | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
109
+ | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
110
+ | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
103
111
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
104
112
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
105
113
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
@@ -145,9 +153,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
145
153
  | [**put_sfvb_recording_settings**](SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront's screen recording on or off |
146
154
  | [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
147
155
  | [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
156
+ | [**refresh_sfvb_comms_sending_domain_status**](SfvbApi.md#refresh_sfvb_comms_sending_domain_status) | **POST** /sfvb/comms/sending_domains/{domain}/status | Check a sending domain's verification |
148
157
  | [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
149
158
  | [**remove_sfvb_page_blog_posts**](SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page |
150
159
  | [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
160
+ | [**render_sfvb_email**](SfvbApi.md#render_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render | Render a flow or campaign email without sending it |
161
+ | [**render_sfvb_transactional_email**](SfvbApi.md#render_sfvb_transactional_email) | **POST** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render | Render a transactional email without sending it |
151
162
  | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
152
163
  | [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
153
164
  | [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
@@ -167,6 +178,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
167
178
  | [**unpublish_sfvb_library_entry**](SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry |
168
179
  | [**unshare_sfvb_library_entry**](SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account |
169
180
  | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
181
+ | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
182
+ | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
170
183
  | [**update_sfvb_item_attribute_batch**](SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call |
171
184
  | [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
172
185
  | [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
@@ -827,6 +840,113 @@ nil (empty response body)
827
840
  - **Accept**: application/json
828
841
 
829
842
 
843
+ ## delete_sfvb_comms_sending_domain
844
+
845
+ > delete_sfvb_comms_sending_domain(domain, opts)
846
+
847
+ Remove a sending domain
848
+
849
+ Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
850
+
851
+
852
+ ### Examples
853
+
854
+
855
+ (No example for this operation).
856
+
857
+
858
+ #### Using the delete_sfvb_comms_sending_domain_with_http_info variant
859
+
860
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
861
+
862
+ > <Array(nil, Integer, Hash)> delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
863
+
864
+ ```ruby
865
+ begin
866
+ # Remove a sending domain
867
+ data, status_code, headers = api_instance.delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
868
+ p status_code # => 2xx
869
+ p headers # => { ... }
870
+ p data # => nil
871
+ rescue UltracartClient::ApiError => e
872
+ puts "Error when calling SfvbApi->delete_sfvb_comms_sending_domain_with_http_info: #{e}"
873
+ end
874
+ ```
875
+
876
+ ### Parameters
877
+
878
+ | Name | Type | Description | Notes |
879
+ | ---- | ---- | ----------- | ----- |
880
+ | **domain** | **String** | | |
881
+ | **approval_id** | **String** | The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals. | [optional] |
882
+
883
+ ### Return type
884
+
885
+ nil (empty response body)
886
+
887
+ ### Authorization
888
+
889
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
890
+
891
+ ### HTTP request headers
892
+
893
+ - **Content-Type**: Not defined
894
+ - **Accept**: application/json
895
+
896
+
897
+ ## delete_sfvb_comms_twilio_account
898
+
899
+ > delete_sfvb_comms_twilio_account(opts)
900
+
901
+ Remove the Twilio account
902
+
903
+ Removes the account's Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
904
+
905
+
906
+ ### Examples
907
+
908
+
909
+ (No example for this operation).
910
+
911
+
912
+ #### Using the delete_sfvb_comms_twilio_account_with_http_info variant
913
+
914
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
915
+
916
+ > <Array(nil, Integer, Hash)> delete_sfvb_comms_twilio_account_with_http_info(opts)
917
+
918
+ ```ruby
919
+ begin
920
+ # Remove the Twilio account
921
+ data, status_code, headers = api_instance.delete_sfvb_comms_twilio_account_with_http_info(opts)
922
+ p status_code # => 2xx
923
+ p headers # => { ... }
924
+ p data # => nil
925
+ rescue UltracartClient::ApiError => e
926
+ puts "Error when calling SfvbApi->delete_sfvb_comms_twilio_account_with_http_info: #{e}"
927
+ end
928
+ ```
929
+
930
+ ### Parameters
931
+
932
+ | Name | Type | Description | Notes |
933
+ | ---- | ---- | ----------- | ----- |
934
+ | **approval_id** | **String** | The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals. | [optional] |
935
+
936
+ ### Return type
937
+
938
+ nil (empty response body)
939
+
940
+ ### Authorization
941
+
942
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
943
+
944
+ ### HTTP request headers
945
+
946
+ - **Content-Type**: Not defined
947
+ - **Accept**: application/json
948
+
949
+
830
950
  ## delete_sfvb_file
831
951
 
832
952
  > delete_sfvb_file(storefront_oid, if_match, opts)
@@ -2516,6 +2636,161 @@ end
2516
2636
  - **Accept**: application/json
2517
2637
 
2518
2638
 
2639
+ ## get_sfvb_comms_sending_domain
2640
+
2641
+ > <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
2642
+
2643
+ Read a sending domain
2644
+
2645
+ One sending domain as stored. To check an amazon domain's DNS again, use the status call.
2646
+
2647
+
2648
+ ### Examples
2649
+
2650
+
2651
+ (No example for this operation).
2652
+
2653
+
2654
+ #### Using the get_sfvb_comms_sending_domain_with_http_info variant
2655
+
2656
+ This returns an Array which contains the response data, status code and headers.
2657
+
2658
+ > <Array(<SfvbCommsSendingDomain>, Integer, Hash)> get_sfvb_comms_sending_domain_with_http_info(domain)
2659
+
2660
+ ```ruby
2661
+ begin
2662
+ # Read a sending domain
2663
+ data, status_code, headers = api_instance.get_sfvb_comms_sending_domain_with_http_info(domain)
2664
+ p status_code # => 2xx
2665
+ p headers # => { ... }
2666
+ p data # => <SfvbCommsSendingDomain>
2667
+ rescue UltracartClient::ApiError => e
2668
+ puts "Error when calling SfvbApi->get_sfvb_comms_sending_domain_with_http_info: #{e}"
2669
+ end
2670
+ ```
2671
+
2672
+ ### Parameters
2673
+
2674
+ | Name | Type | Description | Notes |
2675
+ | ---- | ---- | ----------- | ----- |
2676
+ | **domain** | **String** | | |
2677
+
2678
+ ### Return type
2679
+
2680
+ [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
2681
+
2682
+ ### Authorization
2683
+
2684
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2685
+
2686
+ ### HTTP request headers
2687
+
2688
+ - **Content-Type**: Not defined
2689
+ - **Accept**: application/json
2690
+
2691
+
2692
+ ## get_sfvb_comms_sending_domains
2693
+
2694
+ > <SfvbCommsSendingDomainsResponse> get_sfvb_comms_sending_domains
2695
+
2696
+ List the sending domains
2697
+
2698
+ Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
2699
+
2700
+
2701
+ ### Examples
2702
+
2703
+
2704
+ (No example for this operation).
2705
+
2706
+
2707
+ #### Using the get_sfvb_comms_sending_domains_with_http_info variant
2708
+
2709
+ This returns an Array which contains the response data, status code and headers.
2710
+
2711
+ > <Array(<SfvbCommsSendingDomainsResponse>, Integer, Hash)> get_sfvb_comms_sending_domains_with_http_info
2712
+
2713
+ ```ruby
2714
+ begin
2715
+ # List the sending domains
2716
+ data, status_code, headers = api_instance.get_sfvb_comms_sending_domains_with_http_info
2717
+ p status_code # => 2xx
2718
+ p headers # => { ... }
2719
+ p data # => <SfvbCommsSendingDomainsResponse>
2720
+ rescue UltracartClient::ApiError => e
2721
+ puts "Error when calling SfvbApi->get_sfvb_comms_sending_domains_with_http_info: #{e}"
2722
+ end
2723
+ ```
2724
+
2725
+ ### Parameters
2726
+
2727
+ This endpoint does not need any parameter.
2728
+
2729
+ ### Return type
2730
+
2731
+ [**SfvbCommsSendingDomainsResponse**](SfvbCommsSendingDomainsResponse.md)
2732
+
2733
+ ### Authorization
2734
+
2735
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2736
+
2737
+ ### HTTP request headers
2738
+
2739
+ - **Content-Type**: Not defined
2740
+ - **Accept**: application/json
2741
+
2742
+
2743
+ ## get_sfvb_comms_twilio_account
2744
+
2745
+ > <SfvbCommsTwilioAccountResponse> get_sfvb_comms_twilio_account
2746
+
2747
+ Read the Twilio account
2748
+
2749
+ The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
2750
+
2751
+
2752
+ ### Examples
2753
+
2754
+
2755
+ (No example for this operation).
2756
+
2757
+
2758
+ #### Using the get_sfvb_comms_twilio_account_with_http_info variant
2759
+
2760
+ This returns an Array which contains the response data, status code and headers.
2761
+
2762
+ > <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> get_sfvb_comms_twilio_account_with_http_info
2763
+
2764
+ ```ruby
2765
+ begin
2766
+ # Read the Twilio account
2767
+ data, status_code, headers = api_instance.get_sfvb_comms_twilio_account_with_http_info
2768
+ p status_code # => 2xx
2769
+ p headers # => { ... }
2770
+ p data # => <SfvbCommsTwilioAccountResponse>
2771
+ rescue UltracartClient::ApiError => e
2772
+ puts "Error when calling SfvbApi->get_sfvb_comms_twilio_account_with_http_info: #{e}"
2773
+ end
2774
+ ```
2775
+
2776
+ ### Parameters
2777
+
2778
+ This endpoint does not need any parameter.
2779
+
2780
+ ### Return type
2781
+
2782
+ [**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
2783
+
2784
+ ### Authorization
2785
+
2786
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2787
+
2788
+ ### HTTP request headers
2789
+
2790
+ - **Content-Type**: Not defined
2791
+ - **Accept**: application/json
2792
+
2793
+
2519
2794
  ## get_sfvb_container
2520
2795
 
2521
2796
  > <SfvbContainerResponse> get_sfvb_container(storefront_oid, owner_type, owner_object_id, opts)
@@ -4956,6 +5231,59 @@ end
4956
5231
  - **Accept**: application/json
4957
5232
 
4958
5233
 
5234
+ ## get_sfvb_transactional_emails
5235
+
5236
+ > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
5237
+
5238
+ List the transactional emails a storefront sends
5239
+
5240
+ The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
5241
+
5242
+
5243
+ ### Examples
5244
+
5245
+
5246
+ (No example for this operation).
5247
+
5248
+
5249
+ #### Using the get_sfvb_transactional_emails_with_http_info variant
5250
+
5251
+ This returns an Array which contains the response data, status code and headers.
5252
+
5253
+ > <Array(<SfvbTransactionalEmailsResponse>, Integer, Hash)> get_sfvb_transactional_emails_with_http_info(storefront_oid)
5254
+
5255
+ ```ruby
5256
+ begin
5257
+ # List the transactional emails a storefront sends
5258
+ data, status_code, headers = api_instance.get_sfvb_transactional_emails_with_http_info(storefront_oid)
5259
+ p status_code # => 2xx
5260
+ p headers # => { ... }
5261
+ p data # => <SfvbTransactionalEmailsResponse>
5262
+ rescue UltracartClient::ApiError => e
5263
+ puts "Error when calling SfvbApi->get_sfvb_transactional_emails_with_http_info: #{e}"
5264
+ end
5265
+ ```
5266
+
5267
+ ### Parameters
5268
+
5269
+ | Name | Type | Description | Notes |
5270
+ | ---- | ---- | ----------- | ----- |
5271
+ | **storefront_oid** | **Integer** | | |
5272
+
5273
+ ### Return type
5274
+
5275
+ [**SfvbTransactionalEmailsResponse**](SfvbTransactionalEmailsResponse.md)
5276
+
5277
+ ### Authorization
5278
+
5279
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5280
+
5281
+ ### HTTP request headers
5282
+
5283
+ - **Content-Type**: Not defined
5284
+ - **Accept**: application/json
5285
+
5286
+
4959
5287
  ## get_sfvb_upsell_offer
4960
5288
 
4961
5289
  > <SfvbUpsellOffer> get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts)
@@ -5390,13 +5718,13 @@ end
5390
5718
  - **Accept**: application/json
5391
5719
 
5392
5720
 
5393
- ## insert_sfvb_page
5721
+ ## insert_sfvb_comms_sending_domain
5394
5722
 
5395
- > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
5723
+ > <SfvbCommsSendingDomain> insert_sfvb_comms_sending_domain(sending_domain)
5396
5724
 
5397
- Create a page
5725
+ Add a sending domain
5398
5726
 
5399
- Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
5727
+ Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
5400
5728
 
5401
5729
 
5402
5730
  ### Examples
@@ -5405,15 +5733,121 @@ Creates the page and its folder, the way the store admin's add page does. The p
5405
5733
  (No example for this operation).
5406
5734
 
5407
5735
 
5408
- #### Using the insert_sfvb_page_with_http_info variant
5736
+ #### Using the insert_sfvb_comms_sending_domain_with_http_info variant
5409
5737
 
5410
5738
  This returns an Array which contains the response data, status code and headers.
5411
5739
 
5412
- > <Array(<SfvbPageResponse>, Integer, Hash)> insert_sfvb_page_with_http_info(storefront_oid, page_create_request)
5740
+ > <Array(<SfvbCommsSendingDomain>, Integer, Hash)> insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
5413
5741
 
5414
5742
  ```ruby
5415
5743
  begin
5416
- # Create a page
5744
+ # Add a sending domain
5745
+ data, status_code, headers = api_instance.insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
5746
+ p status_code # => 2xx
5747
+ p headers # => { ... }
5748
+ p data # => <SfvbCommsSendingDomain>
5749
+ rescue UltracartClient::ApiError => e
5750
+ puts "Error when calling SfvbApi->insert_sfvb_comms_sending_domain_with_http_info: #{e}"
5751
+ end
5752
+ ```
5753
+
5754
+ ### Parameters
5755
+
5756
+ | Name | Type | Description | Notes |
5757
+ | ---- | ---- | ----------- | ----- |
5758
+ | **sending_domain** | [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md) | The sending domain | |
5759
+
5760
+ ### Return type
5761
+
5762
+ [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
5763
+
5764
+ ### Authorization
5765
+
5766
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5767
+
5768
+ ### HTTP request headers
5769
+
5770
+ - **Content-Type**: application/json; charset=UTF-8
5771
+ - **Accept**: application/json
5772
+
5773
+
5774
+ ## insert_sfvb_comms_twilio_account
5775
+
5776
+ > <SfvbCommsTwilioAccountResponse> insert_sfvb_comms_twilio_account(twilio_account)
5777
+
5778
+ Connect the Twilio account
5779
+
5780
+ Connects the account's Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
5781
+
5782
+
5783
+ ### Examples
5784
+
5785
+
5786
+ (No example for this operation).
5787
+
5788
+
5789
+ #### Using the insert_sfvb_comms_twilio_account_with_http_info variant
5790
+
5791
+ This returns an Array which contains the response data, status code and headers.
5792
+
5793
+ > <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
5794
+
5795
+ ```ruby
5796
+ begin
5797
+ # Connect the Twilio account
5798
+ data, status_code, headers = api_instance.insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
5799
+ p status_code # => 2xx
5800
+ p headers # => { ... }
5801
+ p data # => <SfvbCommsTwilioAccountResponse>
5802
+ rescue UltracartClient::ApiError => e
5803
+ puts "Error when calling SfvbApi->insert_sfvb_comms_twilio_account_with_http_info: #{e}"
5804
+ end
5805
+ ```
5806
+
5807
+ ### Parameters
5808
+
5809
+ | Name | Type | Description | Notes |
5810
+ | ---- | ---- | ----------- | ----- |
5811
+ | **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | The Twilio account | |
5812
+
5813
+ ### Return type
5814
+
5815
+ [**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
5816
+
5817
+ ### Authorization
5818
+
5819
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5820
+
5821
+ ### HTTP request headers
5822
+
5823
+ - **Content-Type**: application/json; charset=UTF-8
5824
+ - **Accept**: application/json
5825
+
5826
+
5827
+ ## insert_sfvb_page
5828
+
5829
+ > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
5830
+
5831
+ Create a page
5832
+
5833
+ Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
5834
+
5835
+
5836
+ ### Examples
5837
+
5838
+
5839
+ (No example for this operation).
5840
+
5841
+
5842
+ #### Using the insert_sfvb_page_with_http_info variant
5843
+
5844
+ This returns an Array which contains the response data, status code and headers.
5845
+
5846
+ > <Array(<SfvbPageResponse>, Integer, Hash)> insert_sfvb_page_with_http_info(storefront_oid, page_create_request)
5847
+
5848
+ ```ruby
5849
+ begin
5850
+ # Create a page
5417
5851
  data, status_code, headers = api_instance.insert_sfvb_page_with_http_info(storefront_oid, page_create_request)
5418
5852
  p status_code # => 2xx
5419
5853
  p headers # => { ... }
@@ -7884,6 +8318,59 @@ end
7884
8318
  - **Accept**: application/json
7885
8319
 
7886
8320
 
8321
+ ## refresh_sfvb_comms_sending_domain_status
8322
+
8323
+ > <SfvbCommsSendingDomain> refresh_sfvb_comms_sending_domain_status(domain)
8324
+
8325
+ Check a sending domain's verification
8326
+
8327
+ Asks Amazon SES again whether an amazon domain's DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
8328
+
8329
+
8330
+ ### Examples
8331
+
8332
+
8333
+ (No example for this operation).
8334
+
8335
+
8336
+ #### Using the refresh_sfvb_comms_sending_domain_status_with_http_info variant
8337
+
8338
+ This returns an Array which contains the response data, status code and headers.
8339
+
8340
+ > <Array(<SfvbCommsSendingDomain>, Integer, Hash)> refresh_sfvb_comms_sending_domain_status_with_http_info(domain)
8341
+
8342
+ ```ruby
8343
+ begin
8344
+ # Check a sending domain's verification
8345
+ data, status_code, headers = api_instance.refresh_sfvb_comms_sending_domain_status_with_http_info(domain)
8346
+ p status_code # => 2xx
8347
+ p headers # => { ... }
8348
+ p data # => <SfvbCommsSendingDomain>
8349
+ rescue UltracartClient::ApiError => e
8350
+ puts "Error when calling SfvbApi->refresh_sfvb_comms_sending_domain_status_with_http_info: #{e}"
8351
+ end
8352
+ ```
8353
+
8354
+ ### Parameters
8355
+
8356
+ | Name | Type | Description | Notes |
8357
+ | ---- | ---- | ----------- | ----- |
8358
+ | **domain** | **String** | | |
8359
+
8360
+ ### Return type
8361
+
8362
+ [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
8363
+
8364
+ ### Authorization
8365
+
8366
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8367
+
8368
+ ### HTTP request headers
8369
+
8370
+ - **Content-Type**: Not defined
8371
+ - **Accept**: application/json
8372
+
8373
+
7887
8374
  ## refresh_sfvb_page
7888
8375
 
7889
8376
  > <SfvbPageRefreshResponse> refresh_sfvb_page(storefront_oid, page_refresh_request)
@@ -8048,6 +8535,116 @@ end
8048
8535
  - **Accept**: application/json
8049
8536
 
8050
8537
 
8538
+ ## render_sfvb_email
8539
+
8540
+ > <SfvbEmailRenderResponse> render_sfvb_email(storefront_oid, email_uuid, email_render_request)
8541
+
8542
+ Render a flow or campaign email without sending it
8543
+
8544
+ Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
8545
+
8546
+
8547
+ ### Examples
8548
+
8549
+
8550
+ (No example for this operation).
8551
+
8552
+
8553
+ #### Using the render_sfvb_email_with_http_info variant
8554
+
8555
+ This returns an Array which contains the response data, status code and headers.
8556
+
8557
+ > <Array(<SfvbEmailRenderResponse>, Integer, Hash)> render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request)
8558
+
8559
+ ```ruby
8560
+ begin
8561
+ # Render a flow or campaign email without sending it
8562
+ data, status_code, headers = api_instance.render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request)
8563
+ p status_code # => 2xx
8564
+ p headers # => { ... }
8565
+ p data # => <SfvbEmailRenderResponse>
8566
+ rescue UltracartClient::ApiError => e
8567
+ puts "Error when calling SfvbApi->render_sfvb_email_with_http_info: #{e}"
8568
+ end
8569
+ ```
8570
+
8571
+ ### Parameters
8572
+
8573
+ | Name | Type | Description | Notes |
8574
+ | ---- | ---- | ----------- | ----- |
8575
+ | **storefront_oid** | **Integer** | | |
8576
+ | **email_uuid** | **String** | | |
8577
+ | **email_render_request** | [**SfvbEmailRenderRequest**](SfvbEmailRenderRequest.md) | What to render the email with | |
8578
+
8579
+ ### Return type
8580
+
8581
+ [**SfvbEmailRenderResponse**](SfvbEmailRenderResponse.md)
8582
+
8583
+ ### Authorization
8584
+
8585
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8586
+
8587
+ ### HTTP request headers
8588
+
8589
+ - **Content-Type**: application/json
8590
+ - **Accept**: application/json
8591
+
8592
+
8593
+ ## render_sfvb_transactional_email
8594
+
8595
+ > <SfvbEmailRenderResponse> render_sfvb_transactional_email(storefront_oid, file_name, email_render_request)
8596
+
8597
+ Render a transactional email without sending it
8598
+
8599
+ Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email's body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
8600
+
8601
+
8602
+ ### Examples
8603
+
8604
+
8605
+ (No example for this operation).
8606
+
8607
+
8608
+ #### Using the render_sfvb_transactional_email_with_http_info variant
8609
+
8610
+ This returns an Array which contains the response data, status code and headers.
8611
+
8612
+ > <Array(<SfvbEmailRenderResponse>, Integer, Hash)> render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request)
8613
+
8614
+ ```ruby
8615
+ begin
8616
+ # Render a transactional email without sending it
8617
+ data, status_code, headers = api_instance.render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request)
8618
+ p status_code # => 2xx
8619
+ p headers # => { ... }
8620
+ p data # => <SfvbEmailRenderResponse>
8621
+ rescue UltracartClient::ApiError => e
8622
+ puts "Error when calling SfvbApi->render_sfvb_transactional_email_with_http_info: #{e}"
8623
+ end
8624
+ ```
8625
+
8626
+ ### Parameters
8627
+
8628
+ | Name | Type | Description | Notes |
8629
+ | ---- | ---- | ----------- | ----- |
8630
+ | **storefront_oid** | **Integer** | | |
8631
+ | **file_name** | **String** | | |
8632
+ | **email_render_request** | [**SfvbEmailRenderRequest**](SfvbEmailRenderRequest.md) | What to render the email with | |
8633
+
8634
+ ### Return type
8635
+
8636
+ [**SfvbEmailRenderResponse**](SfvbEmailRenderResponse.md)
8637
+
8638
+ ### Authorization
8639
+
8640
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8641
+
8642
+ ### HTTP request headers
8643
+
8644
+ - **Content-Type**: application/json
8645
+ - **Accept**: application/json
8646
+
8647
+
8051
8648
  ## render_sfvb_widgets
8052
8649
 
8053
8650
  > <SfvbRenderResponse> render_sfvb_widgets(storefront_oid, theme_oid, render_request)
@@ -9093,6 +9690,113 @@ end
9093
9690
  - **Accept**: application/json
9094
9691
 
9095
9692
 
9693
+ ## update_sfvb_comms_sending_domain
9694
+
9695
+ > <SfvbCommsSendingDomain> update_sfvb_comms_sending_domain(domain, sending_domain)
9696
+
9697
+ Update a sending domain
9698
+
9699
+ Only a mailgun domain's mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart's webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
9700
+
9701
+
9702
+ ### Examples
9703
+
9704
+
9705
+ (No example for this operation).
9706
+
9707
+
9708
+ #### Using the update_sfvb_comms_sending_domain_with_http_info variant
9709
+
9710
+ This returns an Array which contains the response data, status code and headers.
9711
+
9712
+ > <Array(<SfvbCommsSendingDomain>, Integer, Hash)> update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain)
9713
+
9714
+ ```ruby
9715
+ begin
9716
+ # Update a sending domain
9717
+ data, status_code, headers = api_instance.update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain)
9718
+ p status_code # => 2xx
9719
+ p headers # => { ... }
9720
+ p data # => <SfvbCommsSendingDomain>
9721
+ rescue UltracartClient::ApiError => e
9722
+ puts "Error when calling SfvbApi->update_sfvb_comms_sending_domain_with_http_info: #{e}"
9723
+ end
9724
+ ```
9725
+
9726
+ ### Parameters
9727
+
9728
+ | Name | Type | Description | Notes |
9729
+ | ---- | ---- | ----------- | ----- |
9730
+ | **domain** | **String** | | |
9731
+ | **sending_domain** | [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md) | The changes | |
9732
+
9733
+ ### Return type
9734
+
9735
+ [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
9736
+
9737
+ ### Authorization
9738
+
9739
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9740
+
9741
+ ### HTTP request headers
9742
+
9743
+ - **Content-Type**: application/json; charset=UTF-8
9744
+ - **Accept**: application/json
9745
+
9746
+
9747
+ ## update_sfvb_comms_twilio_account
9748
+
9749
+ > <SfvbCommsTwilioAccountResponse> update_sfvb_comms_twilio_account(twilio_account)
9750
+
9751
+ Update the Twilio account
9752
+
9753
+ Changes the account's Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart's API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
9754
+
9755
+
9756
+ ### Examples
9757
+
9758
+
9759
+ (No example for this operation).
9760
+
9761
+
9762
+ #### Using the update_sfvb_comms_twilio_account_with_http_info variant
9763
+
9764
+ This returns an Array which contains the response data, status code and headers.
9765
+
9766
+ > <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> update_sfvb_comms_twilio_account_with_http_info(twilio_account)
9767
+
9768
+ ```ruby
9769
+ begin
9770
+ # Update the Twilio account
9771
+ data, status_code, headers = api_instance.update_sfvb_comms_twilio_account_with_http_info(twilio_account)
9772
+ p status_code # => 2xx
9773
+ p headers # => { ... }
9774
+ p data # => <SfvbCommsTwilioAccountResponse>
9775
+ rescue UltracartClient::ApiError => e
9776
+ puts "Error when calling SfvbApi->update_sfvb_comms_twilio_account_with_http_info: #{e}"
9777
+ end
9778
+ ```
9779
+
9780
+ ### Parameters
9781
+
9782
+ | Name | Type | Description | Notes |
9783
+ | ---- | ---- | ----------- | ----- |
9784
+ | **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | The changes | |
9785
+
9786
+ ### Return type
9787
+
9788
+ [**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
9789
+
9790
+ ### Authorization
9791
+
9792
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9793
+
9794
+ ### HTTP request headers
9795
+
9796
+ - **Content-Type**: application/json; charset=UTF-8
9797
+ - **Accept**: application/json
9798
+
9799
+
9096
9800
  ## update_sfvb_item_attribute_batch
9097
9801
 
9098
9802
  > <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)