ultracart_api 4.1.203 → 4.1.204
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 +18 -2
- data/docs/SfvbApi.md +538 -0
- data/docs/SfvbApprovalParams.md +4 -0
- data/docs/SfvbCommsDnsRecord.md +24 -0
- data/docs/SfvbCommsSendingDomain.md +38 -0
- data/docs/SfvbCommsSendingDomainsResponse.md +18 -0
- data/docs/SfvbCommsTwilioAccount.md +38 -0
- data/docs/SfvbCommsTwilioAccountResponse.md +20 -0
- data/docs/SfvbSecretRequestCreate.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +654 -0
- data/lib/ultracart_api/models/sfvb_approval_params.rb +21 -1
- data/lib/ultracart_api/models/sfvb_comms_dns_record.rb +296 -0
- data/lib/ultracart_api/models/sfvb_comms_sending_domain.rb +356 -0
- data/lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_comms_twilio_account.rb +322 -0
- data/lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_secret_request_create.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +11 -1
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 |
|
|
@@ -100,6 +105,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
100
105
|
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
101
106
|
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
102
107
|
| [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
|
|
108
|
+
| [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
|
|
109
|
+
| [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
|
|
103
110
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
104
111
|
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
105
112
|
| [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
|
|
@@ -145,6 +152,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
145
152
|
| [**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
153
|
| [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
|
|
147
154
|
| [**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 |
|
|
155
|
+
| [**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
156
|
| [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
|
|
149
157
|
| [**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
158
|
| [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
|
|
@@ -167,6 +175,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
167
175
|
| [**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
176
|
| [**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
177
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
178
|
+
| [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
|
|
179
|
+
| [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
|
|
170
180
|
| [**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
181
|
| [**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
182
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
@@ -827,6 +837,113 @@ nil (empty response body)
|
|
|
827
837
|
- **Accept**: application/json
|
|
828
838
|
|
|
829
839
|
|
|
840
|
+
## delete_sfvb_comms_sending_domain
|
|
841
|
+
|
|
842
|
+
> delete_sfvb_comms_sending_domain(domain, opts)
|
|
843
|
+
|
|
844
|
+
Remove a sending domain
|
|
845
|
+
|
|
846
|
+
Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
### Examples
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
(No example for this operation).
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
#### Using the delete_sfvb_comms_sending_domain_with_http_info variant
|
|
856
|
+
|
|
857
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
858
|
+
|
|
859
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
|
|
860
|
+
|
|
861
|
+
```ruby
|
|
862
|
+
begin
|
|
863
|
+
# Remove a sending domain
|
|
864
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
|
|
865
|
+
p status_code # => 2xx
|
|
866
|
+
p headers # => { ... }
|
|
867
|
+
p data # => nil
|
|
868
|
+
rescue UltracartClient::ApiError => e
|
|
869
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
870
|
+
end
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
### Parameters
|
|
874
|
+
|
|
875
|
+
| Name | Type | Description | Notes |
|
|
876
|
+
| ---- | ---- | ----------- | ----- |
|
|
877
|
+
| **domain** | **String** | | |
|
|
878
|
+
| **approval_id** | **String** | The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals. | [optional] |
|
|
879
|
+
|
|
880
|
+
### Return type
|
|
881
|
+
|
|
882
|
+
nil (empty response body)
|
|
883
|
+
|
|
884
|
+
### Authorization
|
|
885
|
+
|
|
886
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
887
|
+
|
|
888
|
+
### HTTP request headers
|
|
889
|
+
|
|
890
|
+
- **Content-Type**: Not defined
|
|
891
|
+
- **Accept**: application/json
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
## delete_sfvb_comms_twilio_account
|
|
895
|
+
|
|
896
|
+
> delete_sfvb_comms_twilio_account(opts)
|
|
897
|
+
|
|
898
|
+
Remove the Twilio account
|
|
899
|
+
|
|
900
|
+
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).
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
### Examples
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
(No example for this operation).
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
#### Using the delete_sfvb_comms_twilio_account_with_http_info variant
|
|
910
|
+
|
|
911
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
912
|
+
|
|
913
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_comms_twilio_account_with_http_info(opts)
|
|
914
|
+
|
|
915
|
+
```ruby
|
|
916
|
+
begin
|
|
917
|
+
# Remove the Twilio account
|
|
918
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_twilio_account_with_http_info(opts)
|
|
919
|
+
p status_code # => 2xx
|
|
920
|
+
p headers # => { ... }
|
|
921
|
+
p data # => nil
|
|
922
|
+
rescue UltracartClient::ApiError => e
|
|
923
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
924
|
+
end
|
|
925
|
+
```
|
|
926
|
+
|
|
927
|
+
### Parameters
|
|
928
|
+
|
|
929
|
+
| Name | Type | Description | Notes |
|
|
930
|
+
| ---- | ---- | ----------- | ----- |
|
|
931
|
+
| **approval_id** | **String** | The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals. | [optional] |
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
nil (empty response body)
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: application/json
|
|
945
|
+
|
|
946
|
+
|
|
830
947
|
## delete_sfvb_file
|
|
831
948
|
|
|
832
949
|
> delete_sfvb_file(storefront_oid, if_match, opts)
|
|
@@ -2516,6 +2633,161 @@ end
|
|
|
2516
2633
|
- **Accept**: application/json
|
|
2517
2634
|
|
|
2518
2635
|
|
|
2636
|
+
## get_sfvb_comms_sending_domain
|
|
2637
|
+
|
|
2638
|
+
> <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
|
|
2639
|
+
|
|
2640
|
+
Read a sending domain
|
|
2641
|
+
|
|
2642
|
+
One sending domain as stored. To check an amazon domain's DNS again, use the status call.
|
|
2643
|
+
|
|
2644
|
+
|
|
2645
|
+
### Examples
|
|
2646
|
+
|
|
2647
|
+
|
|
2648
|
+
(No example for this operation).
|
|
2649
|
+
|
|
2650
|
+
|
|
2651
|
+
#### Using the get_sfvb_comms_sending_domain_with_http_info variant
|
|
2652
|
+
|
|
2653
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2654
|
+
|
|
2655
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> get_sfvb_comms_sending_domain_with_http_info(domain)
|
|
2656
|
+
|
|
2657
|
+
```ruby
|
|
2658
|
+
begin
|
|
2659
|
+
# Read a sending domain
|
|
2660
|
+
data, status_code, headers = api_instance.get_sfvb_comms_sending_domain_with_http_info(domain)
|
|
2661
|
+
p status_code # => 2xx
|
|
2662
|
+
p headers # => { ... }
|
|
2663
|
+
p data # => <SfvbCommsSendingDomain>
|
|
2664
|
+
rescue UltracartClient::ApiError => e
|
|
2665
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
2666
|
+
end
|
|
2667
|
+
```
|
|
2668
|
+
|
|
2669
|
+
### Parameters
|
|
2670
|
+
|
|
2671
|
+
| Name | Type | Description | Notes |
|
|
2672
|
+
| ---- | ---- | ----------- | ----- |
|
|
2673
|
+
| **domain** | **String** | | |
|
|
2674
|
+
|
|
2675
|
+
### Return type
|
|
2676
|
+
|
|
2677
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
2678
|
+
|
|
2679
|
+
### Authorization
|
|
2680
|
+
|
|
2681
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2682
|
+
|
|
2683
|
+
### HTTP request headers
|
|
2684
|
+
|
|
2685
|
+
- **Content-Type**: Not defined
|
|
2686
|
+
- **Accept**: application/json
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
## get_sfvb_comms_sending_domains
|
|
2690
|
+
|
|
2691
|
+
> <SfvbCommsSendingDomainsResponse> get_sfvb_comms_sending_domains
|
|
2692
|
+
|
|
2693
|
+
List the sending domains
|
|
2694
|
+
|
|
2695
|
+
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.
|
|
2696
|
+
|
|
2697
|
+
|
|
2698
|
+
### Examples
|
|
2699
|
+
|
|
2700
|
+
|
|
2701
|
+
(No example for this operation).
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
#### Using the get_sfvb_comms_sending_domains_with_http_info variant
|
|
2705
|
+
|
|
2706
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2707
|
+
|
|
2708
|
+
> <Array(<SfvbCommsSendingDomainsResponse>, Integer, Hash)> get_sfvb_comms_sending_domains_with_http_info
|
|
2709
|
+
|
|
2710
|
+
```ruby
|
|
2711
|
+
begin
|
|
2712
|
+
# List the sending domains
|
|
2713
|
+
data, status_code, headers = api_instance.get_sfvb_comms_sending_domains_with_http_info
|
|
2714
|
+
p status_code # => 2xx
|
|
2715
|
+
p headers # => { ... }
|
|
2716
|
+
p data # => <SfvbCommsSendingDomainsResponse>
|
|
2717
|
+
rescue UltracartClient::ApiError => e
|
|
2718
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_sending_domains_with_http_info: #{e}"
|
|
2719
|
+
end
|
|
2720
|
+
```
|
|
2721
|
+
|
|
2722
|
+
### Parameters
|
|
2723
|
+
|
|
2724
|
+
This endpoint does not need any parameter.
|
|
2725
|
+
|
|
2726
|
+
### Return type
|
|
2727
|
+
|
|
2728
|
+
[**SfvbCommsSendingDomainsResponse**](SfvbCommsSendingDomainsResponse.md)
|
|
2729
|
+
|
|
2730
|
+
### Authorization
|
|
2731
|
+
|
|
2732
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2733
|
+
|
|
2734
|
+
### HTTP request headers
|
|
2735
|
+
|
|
2736
|
+
- **Content-Type**: Not defined
|
|
2737
|
+
- **Accept**: application/json
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
## get_sfvb_comms_twilio_account
|
|
2741
|
+
|
|
2742
|
+
> <SfvbCommsTwilioAccountResponse> get_sfvb_comms_twilio_account
|
|
2743
|
+
|
|
2744
|
+
Read the Twilio account
|
|
2745
|
+
|
|
2746
|
+
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.
|
|
2747
|
+
|
|
2748
|
+
|
|
2749
|
+
### Examples
|
|
2750
|
+
|
|
2751
|
+
|
|
2752
|
+
(No example for this operation).
|
|
2753
|
+
|
|
2754
|
+
|
|
2755
|
+
#### Using the get_sfvb_comms_twilio_account_with_http_info variant
|
|
2756
|
+
|
|
2757
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2758
|
+
|
|
2759
|
+
> <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> get_sfvb_comms_twilio_account_with_http_info
|
|
2760
|
+
|
|
2761
|
+
```ruby
|
|
2762
|
+
begin
|
|
2763
|
+
# Read the Twilio account
|
|
2764
|
+
data, status_code, headers = api_instance.get_sfvb_comms_twilio_account_with_http_info
|
|
2765
|
+
p status_code # => 2xx
|
|
2766
|
+
p headers # => { ... }
|
|
2767
|
+
p data # => <SfvbCommsTwilioAccountResponse>
|
|
2768
|
+
rescue UltracartClient::ApiError => e
|
|
2769
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
2770
|
+
end
|
|
2771
|
+
```
|
|
2772
|
+
|
|
2773
|
+
### Parameters
|
|
2774
|
+
|
|
2775
|
+
This endpoint does not need any parameter.
|
|
2776
|
+
|
|
2777
|
+
### Return type
|
|
2778
|
+
|
|
2779
|
+
[**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
|
|
2780
|
+
|
|
2781
|
+
### Authorization
|
|
2782
|
+
|
|
2783
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2784
|
+
|
|
2785
|
+
### HTTP request headers
|
|
2786
|
+
|
|
2787
|
+
- **Content-Type**: Not defined
|
|
2788
|
+
- **Accept**: application/json
|
|
2789
|
+
|
|
2790
|
+
|
|
2519
2791
|
## get_sfvb_container
|
|
2520
2792
|
|
|
2521
2793
|
> <SfvbContainerResponse> get_sfvb_container(storefront_oid, owner_type, owner_object_id, opts)
|
|
@@ -5390,6 +5662,112 @@ end
|
|
|
5390
5662
|
- **Accept**: application/json
|
|
5391
5663
|
|
|
5392
5664
|
|
|
5665
|
+
## insert_sfvb_comms_sending_domain
|
|
5666
|
+
|
|
5667
|
+
> <SfvbCommsSendingDomain> insert_sfvb_comms_sending_domain(sending_domain)
|
|
5668
|
+
|
|
5669
|
+
Add a sending domain
|
|
5670
|
+
|
|
5671
|
+
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.
|
|
5672
|
+
|
|
5673
|
+
|
|
5674
|
+
### Examples
|
|
5675
|
+
|
|
5676
|
+
|
|
5677
|
+
(No example for this operation).
|
|
5678
|
+
|
|
5679
|
+
|
|
5680
|
+
#### Using the insert_sfvb_comms_sending_domain_with_http_info variant
|
|
5681
|
+
|
|
5682
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5683
|
+
|
|
5684
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
|
|
5685
|
+
|
|
5686
|
+
```ruby
|
|
5687
|
+
begin
|
|
5688
|
+
# Add a sending domain
|
|
5689
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
|
|
5690
|
+
p status_code # => 2xx
|
|
5691
|
+
p headers # => { ... }
|
|
5692
|
+
p data # => <SfvbCommsSendingDomain>
|
|
5693
|
+
rescue UltracartClient::ApiError => e
|
|
5694
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
5695
|
+
end
|
|
5696
|
+
```
|
|
5697
|
+
|
|
5698
|
+
### Parameters
|
|
5699
|
+
|
|
5700
|
+
| Name | Type | Description | Notes |
|
|
5701
|
+
| ---- | ---- | ----------- | ----- |
|
|
5702
|
+
| **sending_domain** | [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md) | The sending domain | |
|
|
5703
|
+
|
|
5704
|
+
### Return type
|
|
5705
|
+
|
|
5706
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
5707
|
+
|
|
5708
|
+
### Authorization
|
|
5709
|
+
|
|
5710
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5711
|
+
|
|
5712
|
+
### HTTP request headers
|
|
5713
|
+
|
|
5714
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5715
|
+
- **Accept**: application/json
|
|
5716
|
+
|
|
5717
|
+
|
|
5718
|
+
## insert_sfvb_comms_twilio_account
|
|
5719
|
+
|
|
5720
|
+
> <SfvbCommsTwilioAccountResponse> insert_sfvb_comms_twilio_account(twilio_account)
|
|
5721
|
+
|
|
5722
|
+
Connect the Twilio account
|
|
5723
|
+
|
|
5724
|
+
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.
|
|
5725
|
+
|
|
5726
|
+
|
|
5727
|
+
### Examples
|
|
5728
|
+
|
|
5729
|
+
|
|
5730
|
+
(No example for this operation).
|
|
5731
|
+
|
|
5732
|
+
|
|
5733
|
+
#### Using the insert_sfvb_comms_twilio_account_with_http_info variant
|
|
5734
|
+
|
|
5735
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5736
|
+
|
|
5737
|
+
> <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
5738
|
+
|
|
5739
|
+
```ruby
|
|
5740
|
+
begin
|
|
5741
|
+
# Connect the Twilio account
|
|
5742
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
5743
|
+
p status_code # => 2xx
|
|
5744
|
+
p headers # => { ... }
|
|
5745
|
+
p data # => <SfvbCommsTwilioAccountResponse>
|
|
5746
|
+
rescue UltracartClient::ApiError => e
|
|
5747
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
5748
|
+
end
|
|
5749
|
+
```
|
|
5750
|
+
|
|
5751
|
+
### Parameters
|
|
5752
|
+
|
|
5753
|
+
| Name | Type | Description | Notes |
|
|
5754
|
+
| ---- | ---- | ----------- | ----- |
|
|
5755
|
+
| **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | The Twilio account | |
|
|
5756
|
+
|
|
5757
|
+
### Return type
|
|
5758
|
+
|
|
5759
|
+
[**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
|
|
5760
|
+
|
|
5761
|
+
### Authorization
|
|
5762
|
+
|
|
5763
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5764
|
+
|
|
5765
|
+
### HTTP request headers
|
|
5766
|
+
|
|
5767
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5768
|
+
- **Accept**: application/json
|
|
5769
|
+
|
|
5770
|
+
|
|
5393
5771
|
## insert_sfvb_page
|
|
5394
5772
|
|
|
5395
5773
|
> <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
|
|
@@ -7884,6 +8262,59 @@ end
|
|
|
7884
8262
|
- **Accept**: application/json
|
|
7885
8263
|
|
|
7886
8264
|
|
|
8265
|
+
## refresh_sfvb_comms_sending_domain_status
|
|
8266
|
+
|
|
8267
|
+
> <SfvbCommsSendingDomain> refresh_sfvb_comms_sending_domain_status(domain)
|
|
8268
|
+
|
|
8269
|
+
Check a sending domain's verification
|
|
8270
|
+
|
|
8271
|
+
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.
|
|
8272
|
+
|
|
8273
|
+
|
|
8274
|
+
### Examples
|
|
8275
|
+
|
|
8276
|
+
|
|
8277
|
+
(No example for this operation).
|
|
8278
|
+
|
|
8279
|
+
|
|
8280
|
+
#### Using the refresh_sfvb_comms_sending_domain_status_with_http_info variant
|
|
8281
|
+
|
|
8282
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8283
|
+
|
|
8284
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> refresh_sfvb_comms_sending_domain_status_with_http_info(domain)
|
|
8285
|
+
|
|
8286
|
+
```ruby
|
|
8287
|
+
begin
|
|
8288
|
+
# Check a sending domain's verification
|
|
8289
|
+
data, status_code, headers = api_instance.refresh_sfvb_comms_sending_domain_status_with_http_info(domain)
|
|
8290
|
+
p status_code # => 2xx
|
|
8291
|
+
p headers # => { ... }
|
|
8292
|
+
p data # => <SfvbCommsSendingDomain>
|
|
8293
|
+
rescue UltracartClient::ApiError => e
|
|
8294
|
+
puts "Error when calling SfvbApi->refresh_sfvb_comms_sending_domain_status_with_http_info: #{e}"
|
|
8295
|
+
end
|
|
8296
|
+
```
|
|
8297
|
+
|
|
8298
|
+
### Parameters
|
|
8299
|
+
|
|
8300
|
+
| Name | Type | Description | Notes |
|
|
8301
|
+
| ---- | ---- | ----------- | ----- |
|
|
8302
|
+
| **domain** | **String** | | |
|
|
8303
|
+
|
|
8304
|
+
### Return type
|
|
8305
|
+
|
|
8306
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
8307
|
+
|
|
8308
|
+
### Authorization
|
|
8309
|
+
|
|
8310
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8311
|
+
|
|
8312
|
+
### HTTP request headers
|
|
8313
|
+
|
|
8314
|
+
- **Content-Type**: Not defined
|
|
8315
|
+
- **Accept**: application/json
|
|
8316
|
+
|
|
8317
|
+
|
|
7887
8318
|
## refresh_sfvb_page
|
|
7888
8319
|
|
|
7889
8320
|
> <SfvbPageRefreshResponse> refresh_sfvb_page(storefront_oid, page_refresh_request)
|
|
@@ -9093,6 +9524,113 @@ end
|
|
|
9093
9524
|
- **Accept**: application/json
|
|
9094
9525
|
|
|
9095
9526
|
|
|
9527
|
+
## update_sfvb_comms_sending_domain
|
|
9528
|
+
|
|
9529
|
+
> <SfvbCommsSendingDomain> update_sfvb_comms_sending_domain(domain, sending_domain)
|
|
9530
|
+
|
|
9531
|
+
Update a sending domain
|
|
9532
|
+
|
|
9533
|
+
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.
|
|
9534
|
+
|
|
9535
|
+
|
|
9536
|
+
### Examples
|
|
9537
|
+
|
|
9538
|
+
|
|
9539
|
+
(No example for this operation).
|
|
9540
|
+
|
|
9541
|
+
|
|
9542
|
+
#### Using the update_sfvb_comms_sending_domain_with_http_info variant
|
|
9543
|
+
|
|
9544
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9545
|
+
|
|
9546
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain)
|
|
9547
|
+
|
|
9548
|
+
```ruby
|
|
9549
|
+
begin
|
|
9550
|
+
# Update a sending domain
|
|
9551
|
+
data, status_code, headers = api_instance.update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain)
|
|
9552
|
+
p status_code # => 2xx
|
|
9553
|
+
p headers # => { ... }
|
|
9554
|
+
p data # => <SfvbCommsSendingDomain>
|
|
9555
|
+
rescue UltracartClient::ApiError => e
|
|
9556
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
9557
|
+
end
|
|
9558
|
+
```
|
|
9559
|
+
|
|
9560
|
+
### Parameters
|
|
9561
|
+
|
|
9562
|
+
| Name | Type | Description | Notes |
|
|
9563
|
+
| ---- | ---- | ----------- | ----- |
|
|
9564
|
+
| **domain** | **String** | | |
|
|
9565
|
+
| **sending_domain** | [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md) | The changes | |
|
|
9566
|
+
|
|
9567
|
+
### Return type
|
|
9568
|
+
|
|
9569
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
9570
|
+
|
|
9571
|
+
### Authorization
|
|
9572
|
+
|
|
9573
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9574
|
+
|
|
9575
|
+
### HTTP request headers
|
|
9576
|
+
|
|
9577
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
9578
|
+
- **Accept**: application/json
|
|
9579
|
+
|
|
9580
|
+
|
|
9581
|
+
## update_sfvb_comms_twilio_account
|
|
9582
|
+
|
|
9583
|
+
> <SfvbCommsTwilioAccountResponse> update_sfvb_comms_twilio_account(twilio_account)
|
|
9584
|
+
|
|
9585
|
+
Update the Twilio account
|
|
9586
|
+
|
|
9587
|
+
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.
|
|
9588
|
+
|
|
9589
|
+
|
|
9590
|
+
### Examples
|
|
9591
|
+
|
|
9592
|
+
|
|
9593
|
+
(No example for this operation).
|
|
9594
|
+
|
|
9595
|
+
|
|
9596
|
+
#### Using the update_sfvb_comms_twilio_account_with_http_info variant
|
|
9597
|
+
|
|
9598
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9599
|
+
|
|
9600
|
+
> <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> update_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
9601
|
+
|
|
9602
|
+
```ruby
|
|
9603
|
+
begin
|
|
9604
|
+
# Update the Twilio account
|
|
9605
|
+
data, status_code, headers = api_instance.update_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
9606
|
+
p status_code # => 2xx
|
|
9607
|
+
p headers # => { ... }
|
|
9608
|
+
p data # => <SfvbCommsTwilioAccountResponse>
|
|
9609
|
+
rescue UltracartClient::ApiError => e
|
|
9610
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
9611
|
+
end
|
|
9612
|
+
```
|
|
9613
|
+
|
|
9614
|
+
### Parameters
|
|
9615
|
+
|
|
9616
|
+
| Name | Type | Description | Notes |
|
|
9617
|
+
| ---- | ---- | ----------- | ----- |
|
|
9618
|
+
| **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | The changes | |
|
|
9619
|
+
|
|
9620
|
+
### Return type
|
|
9621
|
+
|
|
9622
|
+
[**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
|
|
9623
|
+
|
|
9624
|
+
### Authorization
|
|
9625
|
+
|
|
9626
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9627
|
+
|
|
9628
|
+
### HTTP request headers
|
|
9629
|
+
|
|
9630
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
9631
|
+
- **Accept**: application/json
|
|
9632
|
+
|
|
9633
|
+
|
|
9096
9634
|
## update_sfvb_item_attribute_batch
|
|
9097
9635
|
|
|
9098
9636
|
> <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
| **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change. Set by the server. | [optional] |
|
|
8
8
|
| **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
|
|
9
9
|
| **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
|
|
10
|
+
| **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
|
|
11
|
+
| **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account's esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
|
|
10
12
|
| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
|
|
11
13
|
| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
|
|
12
14
|
| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
|
|
@@ -30,6 +32,8 @@ instance = UltracartClient::SfvbApprovalParams.new(
|
|
|
30
32
|
attribute_names: null,
|
|
31
33
|
blog_post_oid: null,
|
|
32
34
|
content_sha256: null,
|
|
35
|
+
domain: null,
|
|
36
|
+
esp_twilio_uuid: null,
|
|
33
37
|
experiment_oid: null,
|
|
34
38
|
item_count: null,
|
|
35
39
|
merchant_item_oid: null,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbCommsDnsRecord
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The host name, relative to the domain. @ is the domain itself. | [optional] |
|
|
8
|
+
| **purpose** | **String** | What the record is for. verification proves the domain is yours, spf lists who may send for it, and dkim signs its mail. | [optional] |
|
|
9
|
+
| **type** | **String** | The record type. | [optional] |
|
|
10
|
+
| **value** | **String** | The value to publish. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbCommsDnsRecord.new(
|
|
18
|
+
name: null,
|
|
19
|
+
purpose: null,
|
|
20
|
+
type: null,
|
|
21
|
+
value: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbCommsSendingDomain
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **comment** | **String** | For an amazon domain, what UltraCart did last, such as restarting a verification that failed. | [optional] |
|
|
8
|
+
| **dkim_status** | **String** | For an amazon domain, whether the DKIM records were found. Pending, Success or Failed. | [optional] |
|
|
9
|
+
| **dns_records** | [**Array<SfvbCommsDnsRecord>**](SfvbCommsDnsRecord.md) | For an amazon domain, the DNS records to publish. Empty for a mailgun domain, whose records are in Mailgun. | [optional] |
|
|
10
|
+
| **domain** | **String** | The domain mail is sent from. A leading www. or secure. is dropped. Required to create. | [optional] |
|
|
11
|
+
| **esp_domain_uuid** | **String** | UltraCart's id for the sending domain. Set by the server. | [optional] |
|
|
12
|
+
| **identity_status** | **String** | For an amazon domain, whether the verification record was found. Pending until it is, then Success, or Failed after 72 hours. | [optional] |
|
|
13
|
+
| **mailgun_api_key** | **String** | For a mailgun domain, the Mailgun account's private API key. A secret field. Reads return a mask. To set it, send a secret handle (sec_...) made for this domain by POST secrets with sink mailgun.domain.api_key. Send the mask back, or leave it out, to keep it. Required to create a mailgun domain. | [optional] |
|
|
14
|
+
| **provider** | **String** | Who sends the mail. amazon sends through UltraCart after the DNS records are published. mailgun sends through the merchant's own Mailgun account. Required to create, and fixed after. | [optional] |
|
|
15
|
+
| **start_dkim_dts** | **String** | For an amazon domain, when the current DKIM check started. | [optional] |
|
|
16
|
+
| **start_identity_dts** | **String** | For an amazon domain, when the current verification started. | [optional] |
|
|
17
|
+
| **verified** | **Boolean** | True when an amazon domain's verification and DKIM records have both been found, so it can send. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbCommsSendingDomain.new(
|
|
25
|
+
comment: null,
|
|
26
|
+
dkim_status: null,
|
|
27
|
+
dns_records: null,
|
|
28
|
+
domain: null,
|
|
29
|
+
esp_domain_uuid: null,
|
|
30
|
+
identity_status: null,
|
|
31
|
+
mailgun_api_key: null,
|
|
32
|
+
provider: null,
|
|
33
|
+
start_dkim_dts: null,
|
|
34
|
+
start_identity_dts: null,
|
|
35
|
+
verified: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|