ultracart_api 4.1.202 → 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 +32 -2
- data/docs/SfvbApi.md +897 -39
- 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/SfvbEvent.md +2 -2
- data/docs/SfvbSecretHandle.md +32 -0
- data/docs/SfvbSecretKind.md +30 -0
- data/docs/SfvbSecretKindsResponse.md +20 -0
- data/docs/SfvbSecretRequest.md +54 -0
- data/docs/SfvbSecretRequestCreate.md +30 -0
- data/docs/SfvbSecretRequestsResponse.md +18 -0
- data/docs/SfvbSecretSink.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1059 -28
- 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_event.rb +2 -2
- data/lib/ultracart_api/models/sfvb_secret_handle.rb +324 -0
- data/lib/ultracart_api/models/sfvb_secret_kind.rb +280 -0
- data/lib/ultracart_api/models/sfvb_secret_kinds_response.rb +234 -0
- data/lib/ultracart_api/models/sfvb_secret_request.rb +440 -0
- data/lib/ultracart_api/models/sfvb_secret_request_create.rb +284 -0
- data/lib/ultracart_api/models/sfvb_secret_requests_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_secret_sink.rb +250 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +12 -0
- metadata +26 -2
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 |
|
|
@@ -24,6 +26,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
24
26
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
25
27
|
| [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
|
|
26
28
|
| [**delete_sfvb_redirects**](SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call |
|
|
29
|
+
| [**delete_sfvb_secret_request**](SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request |
|
|
27
30
|
| [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
|
|
28
31
|
| [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
|
|
29
32
|
| [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
|
|
@@ -46,6 +49,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
46
49
|
| [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
|
|
47
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 |
|
|
48
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 |
|
|
49
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 |
|
|
50
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 |
|
|
51
57
|
| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
|
|
@@ -82,6 +88,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
82
88
|
| [**get_sfvb_recording_settings**](SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings |
|
|
83
89
|
| [**get_sfvb_redirect**](SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule |
|
|
84
90
|
| [**get_sfvb_redirects**](SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules |
|
|
91
|
+
| [**get_sfvb_secret_kinds**](SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects |
|
|
92
|
+
| [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
|
|
93
|
+
| [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
|
|
85
94
|
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
86
95
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
87
96
|
| [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
|
|
@@ -96,8 +105,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
96
105
|
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
97
106
|
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
98
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 |
|
|
99
110
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
100
111
|
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
112
|
+
| [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
|
|
101
113
|
| [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
|
|
102
114
|
| [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
|
|
103
115
|
| [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
|
|
@@ -140,6 +152,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
140
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 |
|
|
141
153
|
| [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
|
|
142
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 |
|
|
143
156
|
| [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
|
|
144
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 |
|
|
145
158
|
| [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
|
|
@@ -150,6 +163,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
150
163
|
| [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
|
|
151
164
|
| [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
|
|
152
165
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
166
|
+
| [**revoke_sfvb_secret_request**](SfvbApi.md#revoke_sfvb_secret_request) | **POST** /sfvb/secrets/{request_id}/revoke | Revoke a fulfilled request's unused handles |
|
|
153
167
|
| [**search_sfvb_files**](SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files |
|
|
154
168
|
| [**search_sfvb_library**](SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library |
|
|
155
169
|
| [**set_sfvb_library_screenshot**](SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot |
|
|
@@ -161,6 +175,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
161
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 |
|
|
162
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 |
|
|
163
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 |
|
|
164
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 |
|
|
165
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 |
|
|
166
182
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
@@ -612,7 +628,7 @@ end
|
|
|
612
628
|
|
|
613
629
|
One time link that opens a preview in a browser with no UltraCart login
|
|
614
630
|
|
|
615
|
-
The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use.
|
|
631
|
+
The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
|
|
616
632
|
|
|
617
633
|
|
|
618
634
|
### Examples
|
|
@@ -821,6 +837,113 @@ nil (empty response body)
|
|
|
821
837
|
- **Accept**: application/json
|
|
822
838
|
|
|
823
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
|
+
|
|
824
947
|
## delete_sfvb_file
|
|
825
948
|
|
|
826
949
|
> delete_sfvb_file(storefront_oid, if_match, opts)
|
|
@@ -1265,6 +1388,59 @@ end
|
|
|
1265
1388
|
- **Accept**: application/json
|
|
1266
1389
|
|
|
1267
1390
|
|
|
1391
|
+
## delete_sfvb_secret_request
|
|
1392
|
+
|
|
1393
|
+
> <SfvbSecretRequest> delete_sfvb_secret_request(request_id)
|
|
1394
|
+
|
|
1395
|
+
Cancel a pending secret request
|
|
1396
|
+
|
|
1397
|
+
Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
### Examples
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
(No example for this operation).
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
#### Using the delete_sfvb_secret_request_with_http_info variant
|
|
1407
|
+
|
|
1408
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1409
|
+
|
|
1410
|
+
> <Array(<SfvbSecretRequest>, Integer, Hash)> delete_sfvb_secret_request_with_http_info(request_id)
|
|
1411
|
+
|
|
1412
|
+
```ruby
|
|
1413
|
+
begin
|
|
1414
|
+
# Cancel a pending secret request
|
|
1415
|
+
data, status_code, headers = api_instance.delete_sfvb_secret_request_with_http_info(request_id)
|
|
1416
|
+
p status_code # => 2xx
|
|
1417
|
+
p headers # => { ... }
|
|
1418
|
+
p data # => <SfvbSecretRequest>
|
|
1419
|
+
rescue UltracartClient::ApiError => e
|
|
1420
|
+
puts "Error when calling SfvbApi->delete_sfvb_secret_request_with_http_info: #{e}"
|
|
1421
|
+
end
|
|
1422
|
+
```
|
|
1423
|
+
|
|
1424
|
+
### Parameters
|
|
1425
|
+
|
|
1426
|
+
| Name | Type | Description | Notes |
|
|
1427
|
+
| ---- | ---- | ----------- | ----- |
|
|
1428
|
+
| **request_id** | **String** | | |
|
|
1429
|
+
|
|
1430
|
+
### Return type
|
|
1431
|
+
|
|
1432
|
+
[**SfvbSecretRequest**](SfvbSecretRequest.md)
|
|
1433
|
+
|
|
1434
|
+
### Authorization
|
|
1435
|
+
|
|
1436
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1437
|
+
|
|
1438
|
+
### HTTP request headers
|
|
1439
|
+
|
|
1440
|
+
- **Content-Type**: Not defined
|
|
1441
|
+
- **Accept**: application/json
|
|
1442
|
+
|
|
1443
|
+
|
|
1268
1444
|
## detach_sfvb_blog_post_image
|
|
1269
1445
|
|
|
1270
1446
|
> <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
|
|
@@ -2457,6 +2633,161 @@ end
|
|
|
2457
2633
|
- **Accept**: application/json
|
|
2458
2634
|
|
|
2459
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
|
+
|
|
2460
2791
|
## get_sfvb_container
|
|
2461
2792
|
|
|
2462
2793
|
> <SfvbContainerResponse> get_sfvb_container(storefront_oid, owner_type, owner_object_id, opts)
|
|
@@ -4418,6 +4749,161 @@ end
|
|
|
4418
4749
|
- **Accept**: application/json
|
|
4419
4750
|
|
|
4420
4751
|
|
|
4752
|
+
## get_sfvb_secret_kinds
|
|
4753
|
+
|
|
4754
|
+
> <SfvbSecretKindsResponse> get_sfvb_secret_kinds
|
|
4755
|
+
|
|
4756
|
+
List the secrets this server collects
|
|
4757
|
+
|
|
4758
|
+
The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
|
|
4759
|
+
|
|
4760
|
+
|
|
4761
|
+
### Examples
|
|
4762
|
+
|
|
4763
|
+
|
|
4764
|
+
(No example for this operation).
|
|
4765
|
+
|
|
4766
|
+
|
|
4767
|
+
#### Using the get_sfvb_secret_kinds_with_http_info variant
|
|
4768
|
+
|
|
4769
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4770
|
+
|
|
4771
|
+
> <Array(<SfvbSecretKindsResponse>, Integer, Hash)> get_sfvb_secret_kinds_with_http_info
|
|
4772
|
+
|
|
4773
|
+
```ruby
|
|
4774
|
+
begin
|
|
4775
|
+
# List the secrets this server collects
|
|
4776
|
+
data, status_code, headers = api_instance.get_sfvb_secret_kinds_with_http_info
|
|
4777
|
+
p status_code # => 2xx
|
|
4778
|
+
p headers # => { ... }
|
|
4779
|
+
p data # => <SfvbSecretKindsResponse>
|
|
4780
|
+
rescue UltracartClient::ApiError => e
|
|
4781
|
+
puts "Error when calling SfvbApi->get_sfvb_secret_kinds_with_http_info: #{e}"
|
|
4782
|
+
end
|
|
4783
|
+
```
|
|
4784
|
+
|
|
4785
|
+
### Parameters
|
|
4786
|
+
|
|
4787
|
+
This endpoint does not need any parameter.
|
|
4788
|
+
|
|
4789
|
+
### Return type
|
|
4790
|
+
|
|
4791
|
+
[**SfvbSecretKindsResponse**](SfvbSecretKindsResponse.md)
|
|
4792
|
+
|
|
4793
|
+
### Authorization
|
|
4794
|
+
|
|
4795
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4796
|
+
|
|
4797
|
+
### HTTP request headers
|
|
4798
|
+
|
|
4799
|
+
- **Content-Type**: Not defined
|
|
4800
|
+
- **Accept**: application/json
|
|
4801
|
+
|
|
4802
|
+
|
|
4803
|
+
## get_sfvb_secret_request
|
|
4804
|
+
|
|
4805
|
+
> <SfvbSecretRequest> get_sfvb_secret_request(request_id)
|
|
4806
|
+
|
|
4807
|
+
Read one secret request
|
|
4808
|
+
|
|
4809
|
+
Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
|
|
4810
|
+
|
|
4811
|
+
|
|
4812
|
+
### Examples
|
|
4813
|
+
|
|
4814
|
+
|
|
4815
|
+
(No example for this operation).
|
|
4816
|
+
|
|
4817
|
+
|
|
4818
|
+
#### Using the get_sfvb_secret_request_with_http_info variant
|
|
4819
|
+
|
|
4820
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4821
|
+
|
|
4822
|
+
> <Array(<SfvbSecretRequest>, Integer, Hash)> get_sfvb_secret_request_with_http_info(request_id)
|
|
4823
|
+
|
|
4824
|
+
```ruby
|
|
4825
|
+
begin
|
|
4826
|
+
# Read one secret request
|
|
4827
|
+
data, status_code, headers = api_instance.get_sfvb_secret_request_with_http_info(request_id)
|
|
4828
|
+
p status_code # => 2xx
|
|
4829
|
+
p headers # => { ... }
|
|
4830
|
+
p data # => <SfvbSecretRequest>
|
|
4831
|
+
rescue UltracartClient::ApiError => e
|
|
4832
|
+
puts "Error when calling SfvbApi->get_sfvb_secret_request_with_http_info: #{e}"
|
|
4833
|
+
end
|
|
4834
|
+
```
|
|
4835
|
+
|
|
4836
|
+
### Parameters
|
|
4837
|
+
|
|
4838
|
+
| Name | Type | Description | Notes |
|
|
4839
|
+
| ---- | ---- | ----------- | ----- |
|
|
4840
|
+
| **request_id** | **String** | | |
|
|
4841
|
+
|
|
4842
|
+
### Return type
|
|
4843
|
+
|
|
4844
|
+
[**SfvbSecretRequest**](SfvbSecretRequest.md)
|
|
4845
|
+
|
|
4846
|
+
### Authorization
|
|
4847
|
+
|
|
4848
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4849
|
+
|
|
4850
|
+
### HTTP request headers
|
|
4851
|
+
|
|
4852
|
+
- **Content-Type**: Not defined
|
|
4853
|
+
- **Accept**: application/json
|
|
4854
|
+
|
|
4855
|
+
|
|
4856
|
+
## get_sfvb_secret_requests
|
|
4857
|
+
|
|
4858
|
+
> <SfvbSecretRequestsResponse> get_sfvb_secret_requests
|
|
4859
|
+
|
|
4860
|
+
List this sign-in's secret requests
|
|
4861
|
+
|
|
4862
|
+
Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
|
|
4863
|
+
|
|
4864
|
+
|
|
4865
|
+
### Examples
|
|
4866
|
+
|
|
4867
|
+
|
|
4868
|
+
(No example for this operation).
|
|
4869
|
+
|
|
4870
|
+
|
|
4871
|
+
#### Using the get_sfvb_secret_requests_with_http_info variant
|
|
4872
|
+
|
|
4873
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4874
|
+
|
|
4875
|
+
> <Array(<SfvbSecretRequestsResponse>, Integer, Hash)> get_sfvb_secret_requests_with_http_info
|
|
4876
|
+
|
|
4877
|
+
```ruby
|
|
4878
|
+
begin
|
|
4879
|
+
# List this sign-in's secret requests
|
|
4880
|
+
data, status_code, headers = api_instance.get_sfvb_secret_requests_with_http_info
|
|
4881
|
+
p status_code # => 2xx
|
|
4882
|
+
p headers # => { ... }
|
|
4883
|
+
p data # => <SfvbSecretRequestsResponse>
|
|
4884
|
+
rescue UltracartClient::ApiError => e
|
|
4885
|
+
puts "Error when calling SfvbApi->get_sfvb_secret_requests_with_http_info: #{e}"
|
|
4886
|
+
end
|
|
4887
|
+
```
|
|
4888
|
+
|
|
4889
|
+
### Parameters
|
|
4890
|
+
|
|
4891
|
+
This endpoint does not need any parameter.
|
|
4892
|
+
|
|
4893
|
+
### Return type
|
|
4894
|
+
|
|
4895
|
+
[**SfvbSecretRequestsResponse**](SfvbSecretRequestsResponse.md)
|
|
4896
|
+
|
|
4897
|
+
### Authorization
|
|
4898
|
+
|
|
4899
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4900
|
+
|
|
4901
|
+
### HTTP request headers
|
|
4902
|
+
|
|
4903
|
+
- **Content-Type**: Not defined
|
|
4904
|
+
- **Accept**: application/json
|
|
4905
|
+
|
|
4906
|
+
|
|
4421
4907
|
## get_sfvb_server_log
|
|
4422
4908
|
|
|
4423
4909
|
> <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
|
|
@@ -5014,13 +5500,121 @@ end
|
|
|
5014
5500
|
- **Accept**: application/json
|
|
5015
5501
|
|
|
5016
5502
|
|
|
5017
|
-
## import_sfvb_redirects
|
|
5503
|
+
## import_sfvb_redirects
|
|
5504
|
+
|
|
5505
|
+
> <SfvbRedirectImportResponse> import_sfvb_redirects(storefront_oid, redirect_import_request)
|
|
5506
|
+
|
|
5507
|
+
Apply a reviewed redirect import
|
|
5508
|
+
|
|
5509
|
+
Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
|
|
5510
|
+
|
|
5511
|
+
|
|
5512
|
+
### Examples
|
|
5513
|
+
|
|
5514
|
+
|
|
5515
|
+
(No example for this operation).
|
|
5516
|
+
|
|
5517
|
+
|
|
5518
|
+
#### Using the import_sfvb_redirects_with_http_info variant
|
|
5519
|
+
|
|
5520
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5521
|
+
|
|
5522
|
+
> <Array(<SfvbRedirectImportResponse>, Integer, Hash)> import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
|
|
5523
|
+
|
|
5524
|
+
```ruby
|
|
5525
|
+
begin
|
|
5526
|
+
# Apply a reviewed redirect import
|
|
5527
|
+
data, status_code, headers = api_instance.import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
|
|
5528
|
+
p status_code # => 2xx
|
|
5529
|
+
p headers # => { ... }
|
|
5530
|
+
p data # => <SfvbRedirectImportResponse>
|
|
5531
|
+
rescue UltracartClient::ApiError => e
|
|
5532
|
+
puts "Error when calling SfvbApi->import_sfvb_redirects_with_http_info: #{e}"
|
|
5533
|
+
end
|
|
5534
|
+
```
|
|
5535
|
+
|
|
5536
|
+
### Parameters
|
|
5537
|
+
|
|
5538
|
+
| Name | Type | Description | Notes |
|
|
5539
|
+
| ---- | ---- | ----------- | ----- |
|
|
5540
|
+
| **storefront_oid** | **Integer** | | |
|
|
5541
|
+
| **redirect_import_request** | [**SfvbRedirectImportRequest**](SfvbRedirectImportRequest.md) | The request | |
|
|
5542
|
+
|
|
5543
|
+
### Return type
|
|
5544
|
+
|
|
5545
|
+
[**SfvbRedirectImportResponse**](SfvbRedirectImportResponse.md)
|
|
5546
|
+
|
|
5547
|
+
### Authorization
|
|
5548
|
+
|
|
5549
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5550
|
+
|
|
5551
|
+
### HTTP request headers
|
|
5552
|
+
|
|
5553
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5554
|
+
- **Accept**: application/json
|
|
5555
|
+
|
|
5556
|
+
|
|
5557
|
+
## insert_sfvb_approval
|
|
5558
|
+
|
|
5559
|
+
> <SfvbApproval> insert_sfvb_approval(approval_request, opts)
|
|
5560
|
+
|
|
5561
|
+
Request a human approval
|
|
5562
|
+
|
|
5563
|
+
Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert. The request starts as reviewing while UltraCart's scanner and two AI models read it, then becomes pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same bytes.
|
|
5564
|
+
|
|
5565
|
+
|
|
5566
|
+
### Examples
|
|
5567
|
+
|
|
5568
|
+
|
|
5569
|
+
(No example for this operation).
|
|
5570
|
+
|
|
5571
|
+
|
|
5572
|
+
#### Using the insert_sfvb_approval_with_http_info variant
|
|
5573
|
+
|
|
5574
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5575
|
+
|
|
5576
|
+
> <Array(<SfvbApproval>, Integer, Hash)> insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
5577
|
+
|
|
5578
|
+
```ruby
|
|
5579
|
+
begin
|
|
5580
|
+
# Request a human approval
|
|
5581
|
+
data, status_code, headers = api_instance.insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
5582
|
+
p status_code # => 2xx
|
|
5583
|
+
p headers # => { ... }
|
|
5584
|
+
p data # => <SfvbApproval>
|
|
5585
|
+
rescue UltracartClient::ApiError => e
|
|
5586
|
+
puts "Error when calling SfvbApi->insert_sfvb_approval_with_http_info: #{e}"
|
|
5587
|
+
end
|
|
5588
|
+
```
|
|
5589
|
+
|
|
5590
|
+
### Parameters
|
|
5591
|
+
|
|
5592
|
+
| Name | Type | Description | Notes |
|
|
5593
|
+
| ---- | ---- | ----------- | ----- |
|
|
5594
|
+
| **approval_request** | [**SfvbApprovalCreateRequest**](SfvbApprovalCreateRequest.md) | The request | |
|
|
5595
|
+
| **storefront_oid** | **Integer** | The storefront the action runs on. Required for storefront actions, left out for account-wide ones. | [optional] |
|
|
5596
|
+
|
|
5597
|
+
### Return type
|
|
5598
|
+
|
|
5599
|
+
[**SfvbApproval**](SfvbApproval.md)
|
|
5600
|
+
|
|
5601
|
+
### Authorization
|
|
5602
|
+
|
|
5603
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5604
|
+
|
|
5605
|
+
### HTTP request headers
|
|
5606
|
+
|
|
5607
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5608
|
+
- **Accept**: application/json
|
|
5609
|
+
|
|
5610
|
+
|
|
5611
|
+
## insert_sfvb_blog_post
|
|
5018
5612
|
|
|
5019
|
-
> <
|
|
5613
|
+
> <SfvbBlogPostDetail> insert_sfvb_blog_post(storefront_oid, blog_post_request)
|
|
5020
5614
|
|
|
5021
|
-
|
|
5615
|
+
Create a blog post
|
|
5022
5616
|
|
|
5023
|
-
|
|
5617
|
+
title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page's selectors choose it.
|
|
5024
5618
|
|
|
5025
5619
|
|
|
5026
5620
|
### Examples
|
|
@@ -5029,21 +5623,21 @@ Applies exactly the rows of a dry run, given its plan_hash, in one transaction.
|
|
|
5029
5623
|
(No example for this operation).
|
|
5030
5624
|
|
|
5031
5625
|
|
|
5032
|
-
#### Using the
|
|
5626
|
+
#### Using the insert_sfvb_blog_post_with_http_info variant
|
|
5033
5627
|
|
|
5034
5628
|
This returns an Array which contains the response data, status code and headers.
|
|
5035
5629
|
|
|
5036
|
-
> <Array(<
|
|
5630
|
+
> <Array(<SfvbBlogPostDetail>, Integer, Hash)> insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
|
|
5037
5631
|
|
|
5038
5632
|
```ruby
|
|
5039
5633
|
begin
|
|
5040
|
-
#
|
|
5041
|
-
data, status_code, headers = api_instance.
|
|
5634
|
+
# Create a blog post
|
|
5635
|
+
data, status_code, headers = api_instance.insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
|
|
5042
5636
|
p status_code # => 2xx
|
|
5043
5637
|
p headers # => { ... }
|
|
5044
|
-
p data # => <
|
|
5638
|
+
p data # => <SfvbBlogPostDetail>
|
|
5045
5639
|
rescue UltracartClient::ApiError => e
|
|
5046
|
-
puts "Error when calling SfvbApi->
|
|
5640
|
+
puts "Error when calling SfvbApi->insert_sfvb_blog_post_with_http_info: #{e}"
|
|
5047
5641
|
end
|
|
5048
5642
|
```
|
|
5049
5643
|
|
|
@@ -5052,11 +5646,11 @@ end
|
|
|
5052
5646
|
| Name | Type | Description | Notes |
|
|
5053
5647
|
| ---- | ---- | ----------- | ----- |
|
|
5054
5648
|
| **storefront_oid** | **Integer** | | |
|
|
5055
|
-
| **
|
|
5649
|
+
| **blog_post_request** | [**SfvbBlogPostRequest**](SfvbBlogPostRequest.md) | The blog post to create | |
|
|
5056
5650
|
|
|
5057
5651
|
### Return type
|
|
5058
5652
|
|
|
5059
|
-
[**
|
|
5653
|
+
[**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
|
|
5060
5654
|
|
|
5061
5655
|
### Authorization
|
|
5062
5656
|
|
|
@@ -5068,13 +5662,13 @@ end
|
|
|
5068
5662
|
- **Accept**: application/json
|
|
5069
5663
|
|
|
5070
5664
|
|
|
5071
|
-
##
|
|
5665
|
+
## insert_sfvb_comms_sending_domain
|
|
5072
5666
|
|
|
5073
|
-
> <
|
|
5667
|
+
> <SfvbCommsSendingDomain> insert_sfvb_comms_sending_domain(sending_domain)
|
|
5074
5668
|
|
|
5075
|
-
|
|
5669
|
+
Add a sending domain
|
|
5076
5670
|
|
|
5077
|
-
|
|
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.
|
|
5078
5672
|
|
|
5079
5673
|
|
|
5080
5674
|
### Examples
|
|
@@ -5083,21 +5677,21 @@ Asks the person who signed in the CLI to approve one gated action on one exact t
|
|
|
5083
5677
|
(No example for this operation).
|
|
5084
5678
|
|
|
5085
5679
|
|
|
5086
|
-
#### Using the
|
|
5680
|
+
#### Using the insert_sfvb_comms_sending_domain_with_http_info variant
|
|
5087
5681
|
|
|
5088
5682
|
This returns an Array which contains the response data, status code and headers.
|
|
5089
5683
|
|
|
5090
|
-
> <Array(<
|
|
5684
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
|
|
5091
5685
|
|
|
5092
5686
|
```ruby
|
|
5093
5687
|
begin
|
|
5094
|
-
#
|
|
5095
|
-
data, status_code, headers = api_instance.
|
|
5688
|
+
# Add a sending domain
|
|
5689
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_sending_domain_with_http_info(sending_domain)
|
|
5096
5690
|
p status_code # => 2xx
|
|
5097
5691
|
p headers # => { ... }
|
|
5098
|
-
p data # => <
|
|
5692
|
+
p data # => <SfvbCommsSendingDomain>
|
|
5099
5693
|
rescue UltracartClient::ApiError => e
|
|
5100
|
-
puts "Error when calling SfvbApi->
|
|
5694
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
5101
5695
|
end
|
|
5102
5696
|
```
|
|
5103
5697
|
|
|
@@ -5105,12 +5699,11 @@ end
|
|
|
5105
5699
|
|
|
5106
5700
|
| Name | Type | Description | Notes |
|
|
5107
5701
|
| ---- | ---- | ----------- | ----- |
|
|
5108
|
-
| **
|
|
5109
|
-
| **storefront_oid** | **Integer** | The storefront the action runs on. Required for storefront actions, left out for account-wide ones. | [optional] |
|
|
5702
|
+
| **sending_domain** | [**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md) | The sending domain | |
|
|
5110
5703
|
|
|
5111
5704
|
### Return type
|
|
5112
5705
|
|
|
5113
|
-
[**
|
|
5706
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
5114
5707
|
|
|
5115
5708
|
### Authorization
|
|
5116
5709
|
|
|
@@ -5122,13 +5715,13 @@ end
|
|
|
5122
5715
|
- **Accept**: application/json
|
|
5123
5716
|
|
|
5124
5717
|
|
|
5125
|
-
##
|
|
5718
|
+
## insert_sfvb_comms_twilio_account
|
|
5126
5719
|
|
|
5127
|
-
> <
|
|
5720
|
+
> <SfvbCommsTwilioAccountResponse> insert_sfvb_comms_twilio_account(twilio_account)
|
|
5128
5721
|
|
|
5129
|
-
|
|
5722
|
+
Connect the Twilio account
|
|
5130
5723
|
|
|
5131
|
-
|
|
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.
|
|
5132
5725
|
|
|
5133
5726
|
|
|
5134
5727
|
### Examples
|
|
@@ -5137,21 +5730,21 @@ title and url_part are required. The post is a draft unless visibility says oth
|
|
|
5137
5730
|
(No example for this operation).
|
|
5138
5731
|
|
|
5139
5732
|
|
|
5140
|
-
#### Using the
|
|
5733
|
+
#### Using the insert_sfvb_comms_twilio_account_with_http_info variant
|
|
5141
5734
|
|
|
5142
5735
|
This returns an Array which contains the response data, status code and headers.
|
|
5143
5736
|
|
|
5144
|
-
> <Array(<
|
|
5737
|
+
> <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
5145
5738
|
|
|
5146
5739
|
```ruby
|
|
5147
5740
|
begin
|
|
5148
|
-
#
|
|
5149
|
-
data, status_code, headers = api_instance.
|
|
5741
|
+
# Connect the Twilio account
|
|
5742
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_twilio_account_with_http_info(twilio_account)
|
|
5150
5743
|
p status_code # => 2xx
|
|
5151
5744
|
p headers # => { ... }
|
|
5152
|
-
p data # => <
|
|
5745
|
+
p data # => <SfvbCommsTwilioAccountResponse>
|
|
5153
5746
|
rescue UltracartClient::ApiError => e
|
|
5154
|
-
puts "Error when calling SfvbApi->
|
|
5747
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
5155
5748
|
end
|
|
5156
5749
|
```
|
|
5157
5750
|
|
|
@@ -5159,12 +5752,11 @@ end
|
|
|
5159
5752
|
|
|
5160
5753
|
| Name | Type | Description | Notes |
|
|
5161
5754
|
| ---- | ---- | ----------- | ----- |
|
|
5162
|
-
| **
|
|
5163
|
-
| **blog_post_request** | [**SfvbBlogPostRequest**](SfvbBlogPostRequest.md) | The blog post to create | |
|
|
5755
|
+
| **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | The Twilio account | |
|
|
5164
5756
|
|
|
5165
5757
|
### Return type
|
|
5166
5758
|
|
|
5167
|
-
[**
|
|
5759
|
+
[**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
|
|
5168
5760
|
|
|
5169
5761
|
### Authorization
|
|
5170
5762
|
|
|
@@ -5284,6 +5876,59 @@ end
|
|
|
5284
5876
|
- **Accept**: application/json
|
|
5285
5877
|
|
|
5286
5878
|
|
|
5879
|
+
## insert_sfvb_secret_request
|
|
5880
|
+
|
|
5881
|
+
> <SfvbSecretRequest> insert_sfvb_secret_request(secret_request)
|
|
5882
|
+
|
|
5883
|
+
Ask a person to enter secret values
|
|
5884
|
+
|
|
5885
|
+
Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
|
|
5886
|
+
|
|
5887
|
+
|
|
5888
|
+
### Examples
|
|
5889
|
+
|
|
5890
|
+
|
|
5891
|
+
(No example for this operation).
|
|
5892
|
+
|
|
5893
|
+
|
|
5894
|
+
#### Using the insert_sfvb_secret_request_with_http_info variant
|
|
5895
|
+
|
|
5896
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5897
|
+
|
|
5898
|
+
> <Array(<SfvbSecretRequest>, Integer, Hash)> insert_sfvb_secret_request_with_http_info(secret_request)
|
|
5899
|
+
|
|
5900
|
+
```ruby
|
|
5901
|
+
begin
|
|
5902
|
+
# Ask a person to enter secret values
|
|
5903
|
+
data, status_code, headers = api_instance.insert_sfvb_secret_request_with_http_info(secret_request)
|
|
5904
|
+
p status_code # => 2xx
|
|
5905
|
+
p headers # => { ... }
|
|
5906
|
+
p data # => <SfvbSecretRequest>
|
|
5907
|
+
rescue UltracartClient::ApiError => e
|
|
5908
|
+
puts "Error when calling SfvbApi->insert_sfvb_secret_request_with_http_info: #{e}"
|
|
5909
|
+
end
|
|
5910
|
+
```
|
|
5911
|
+
|
|
5912
|
+
### Parameters
|
|
5913
|
+
|
|
5914
|
+
| Name | Type | Description | Notes |
|
|
5915
|
+
| ---- | ---- | ----------- | ----- |
|
|
5916
|
+
| **secret_request** | [**SfvbSecretRequestCreate**](SfvbSecretRequestCreate.md) | The request | |
|
|
5917
|
+
|
|
5918
|
+
### Return type
|
|
5919
|
+
|
|
5920
|
+
[**SfvbSecretRequest**](SfvbSecretRequest.md)
|
|
5921
|
+
|
|
5922
|
+
### Authorization
|
|
5923
|
+
|
|
5924
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5925
|
+
|
|
5926
|
+
### HTTP request headers
|
|
5927
|
+
|
|
5928
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5929
|
+
- **Accept**: application/json
|
|
5930
|
+
|
|
5931
|
+
|
|
5287
5932
|
## insert_sfvb_upsell_offer
|
|
5288
5933
|
|
|
5289
5934
|
> <SfvbUpsellOffer> insert_sfvb_upsell_offer(storefront_oid, upsell_offer)
|
|
@@ -7617,6 +8262,59 @@ end
|
|
|
7617
8262
|
- **Accept**: application/json
|
|
7618
8263
|
|
|
7619
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
|
+
|
|
7620
8318
|
## refresh_sfvb_page
|
|
7621
8319
|
|
|
7622
8320
|
> <SfvbPageRefreshResponse> refresh_sfvb_page(storefront_oid, page_refresh_request)
|
|
@@ -8169,6 +8867,59 @@ end
|
|
|
8169
8867
|
- **Accept**: application/json
|
|
8170
8868
|
|
|
8171
8869
|
|
|
8870
|
+
## revoke_sfvb_secret_request
|
|
8871
|
+
|
|
8872
|
+
> <SfvbSecretRequest> revoke_sfvb_secret_request(request_id)
|
|
8873
|
+
|
|
8874
|
+
Revoke a fulfilled request's unused handles
|
|
8875
|
+
|
|
8876
|
+
Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
|
|
8877
|
+
|
|
8878
|
+
|
|
8879
|
+
### Examples
|
|
8880
|
+
|
|
8881
|
+
|
|
8882
|
+
(No example for this operation).
|
|
8883
|
+
|
|
8884
|
+
|
|
8885
|
+
#### Using the revoke_sfvb_secret_request_with_http_info variant
|
|
8886
|
+
|
|
8887
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8888
|
+
|
|
8889
|
+
> <Array(<SfvbSecretRequest>, Integer, Hash)> revoke_sfvb_secret_request_with_http_info(request_id)
|
|
8890
|
+
|
|
8891
|
+
```ruby
|
|
8892
|
+
begin
|
|
8893
|
+
# Revoke a fulfilled request's unused handles
|
|
8894
|
+
data, status_code, headers = api_instance.revoke_sfvb_secret_request_with_http_info(request_id)
|
|
8895
|
+
p status_code # => 2xx
|
|
8896
|
+
p headers # => { ... }
|
|
8897
|
+
p data # => <SfvbSecretRequest>
|
|
8898
|
+
rescue UltracartClient::ApiError => e
|
|
8899
|
+
puts "Error when calling SfvbApi->revoke_sfvb_secret_request_with_http_info: #{e}"
|
|
8900
|
+
end
|
|
8901
|
+
```
|
|
8902
|
+
|
|
8903
|
+
### Parameters
|
|
8904
|
+
|
|
8905
|
+
| Name | Type | Description | Notes |
|
|
8906
|
+
| ---- | ---- | ----------- | ----- |
|
|
8907
|
+
| **request_id** | **String** | | |
|
|
8908
|
+
|
|
8909
|
+
### Return type
|
|
8910
|
+
|
|
8911
|
+
[**SfvbSecretRequest**](SfvbSecretRequest.md)
|
|
8912
|
+
|
|
8913
|
+
### Authorization
|
|
8914
|
+
|
|
8915
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8916
|
+
|
|
8917
|
+
### HTTP request headers
|
|
8918
|
+
|
|
8919
|
+
- **Content-Type**: Not defined
|
|
8920
|
+
- **Accept**: application/json
|
|
8921
|
+
|
|
8922
|
+
|
|
8172
8923
|
## search_sfvb_files
|
|
8173
8924
|
|
|
8174
8925
|
> <SfvbFileSearchResponse> search_sfvb_files(storefront_oid, search_request)
|
|
@@ -8773,6 +9524,113 @@ end
|
|
|
8773
9524
|
- **Accept**: application/json
|
|
8774
9525
|
|
|
8775
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
|
+
|
|
8776
9634
|
## update_sfvb_item_attribute_batch
|
|
8777
9635
|
|
|
8778
9636
|
> <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)
|