ultracart_api 4.1.185 → 4.1.190
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 +33 -2
- data/docs/SfvbApi.md +621 -0
- data/docs/SfvbI18nGlossary.md +24 -0
- data/docs/SfvbI18nGlossaryRequest.md +18 -0
- data/docs/SfvbI18nLanguage.md +30 -0
- data/docs/SfvbI18nLanguageEnableRequest.md +18 -0
- data/docs/SfvbI18nLanguagesResponse.md +32 -0
- data/docs/SfvbI18nMachineTranslationsResponse.md +28 -0
- data/docs/SfvbI18nMessage.md +30 -0
- data/docs/SfvbI18nMessageValue.md +20 -0
- data/docs/SfvbI18nMessageWriteRequest.md +18 -0
- data/docs/SfvbI18nMessagesResponse.md +28 -0
- data/docs/SfvbI18nResetResponse.md +22 -0
- data/docs/SfvbI18nTranslation.md +22 -0
- data/docs/SfvbLibraryAiReview.md +1 -1
- data/docs/SfvbLibraryContentManifest.md +4 -4
- data/docs/SfvbLibraryManifestFinding.md +22 -0
- data/docs/SfvbLibraryParameter.md +2 -2
- data/docs/SfvbLibraryTaxonomyCatalog.md +1 -1
- data/docs/SfvbLibraryTaxonomyDimension.md +22 -0
- data/docs/SfvbLibraryTaxonomyTag.md +20 -0
- data/lib/ultracart_api/api/sfvb_api.rb +860 -17
- data/lib/ultracart_api/models/sfvb_i18n_glossary.rb +250 -0
- data/lib/ultracart_api/models/sfvb_i18n_glossary_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_i18n_language.rb +282 -0
- data/lib/ultracart_api/models/sfvb_i18n_language_enable_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_i18n_languages_response.rb +292 -0
- data/lib/ultracart_api/models/sfvb_i18n_machine_translations_response.rb +272 -0
- data/lib/ultracart_api/models/sfvb_i18n_message.rb +282 -0
- data/lib/ultracart_api/models/sfvb_i18n_message_value.rb +230 -0
- data/lib/ultracart_api/models/sfvb_i18n_message_write_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_i18n_messages_response.rb +272 -0
- data/lib/ultracart_api/models/sfvb_i18n_reset_response.rb +240 -0
- data/lib/ultracart_api/models/sfvb_i18n_translation.rb +240 -0
- data/lib/ultracart_api/models/sfvb_library_ai_review.rb +4 -2
- data/lib/ultracart_api/models/sfvb_library_content_manifest.rb +16 -8
- data/lib/ultracart_api/models/sfvb_library_manifest_finding.rb +240 -0
- data/lib/ultracart_api/models/sfvb_library_parameter.rb +7 -7
- data/lib/ultracart_api/models/sfvb_library_taxonomy_catalog.rb +4 -2
- data/lib/ultracart_api/models/sfvb_library_taxonomy_dimension.rb +276 -0
- data/lib/ultracart_api/models/sfvb_library_taxonomy_tag.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +15 -0
- metadata +32 -2
data/docs/SfvbApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
21
21
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
22
22
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
23
23
|
| [**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 |
|
|
24
|
+
| [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
|
|
24
25
|
| [**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 |
|
|
25
26
|
| [**disable_sfvb_upsell_path**](SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path |
|
|
26
27
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
@@ -29,6 +30,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
29
30
|
| [**duplicate_sfvb_theme**](SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme |
|
|
30
31
|
| [**duplicate_sfvb_upsell_offer**](SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer |
|
|
31
32
|
| [**duplicate_sfvb_upsell_path**](SfvbApi.md#duplicate_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/duplicate | Duplicate an upsell path or one of its variations |
|
|
33
|
+
| [**enable_sfvb_i18n_language**](SfvbApi.md#enable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable | Enable a language |
|
|
32
34
|
| [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
|
|
33
35
|
| [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
|
|
34
36
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
@@ -40,6 +42,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
40
42
|
| [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
|
|
41
43
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
42
44
|
| [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
|
|
45
|
+
| [**get_sfvb_i18n_glossary**](SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary |
|
|
46
|
+
| [**get_sfvb_i18n_languages**](SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages |
|
|
47
|
+
| [**get_sfvb_i18n_machine_translations**](SfvbApi.md#get_sfvb_i18n_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/machine_translations | Read where a widget setting's translations come from |
|
|
48
|
+
| [**get_sfvb_i18n_message**](SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message |
|
|
49
|
+
| [**get_sfvb_i18n_message_machine_translations**](SfvbApi.md#get_sfvb_i18n_message_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations | Read where a message's translations come from |
|
|
43
50
|
| [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
|
|
44
51
|
| [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
|
|
45
52
|
| [**get_sfvb_library_history**](SfvbApi.md#get_sfvb_library_history) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/history | List a library entry's published revisions |
|
|
@@ -75,6 +82,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
75
82
|
| [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
|
|
76
83
|
| [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
|
|
77
84
|
| [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
|
|
85
|
+
| [**list_sfvb_i18n_messages**](SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages |
|
|
78
86
|
| [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
|
|
79
87
|
| [**list_sfvb_library_installs**](SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront |
|
|
80
88
|
| [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
|
|
@@ -89,6 +97,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
89
97
|
| [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
|
|
90
98
|
| [**put_sfvb_experiment_variation**](SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation |
|
|
91
99
|
| [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
|
|
100
|
+
| [**put_sfvb_i18n_glossary**](SfvbApi.md#put_sfvb_i18n_glossary) | **PUT** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Replace the storefront's translation glossary |
|
|
101
|
+
| [**put_sfvb_i18n_message**](SfvbApi.md#put_sfvb_i18n_message) | **PUT** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Change one built-in message |
|
|
92
102
|
| [**put_sfvb_item_attributes**](SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes |
|
|
93
103
|
| [**put_sfvb_item_content**](SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description |
|
|
94
104
|
| [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
|
|
@@ -107,6 +117,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
107
117
|
| [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
|
|
108
118
|
| [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
|
|
109
119
|
| [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
|
|
120
|
+
| [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
|
|
110
121
|
| [**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 |
|
|
111
122
|
| [**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 |
|
|
112
123
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
@@ -1058,6 +1069,61 @@ end
|
|
|
1058
1069
|
- **Accept**: application/json
|
|
1059
1070
|
|
|
1060
1071
|
|
|
1072
|
+
## disable_sfvb_i18n_language
|
|
1073
|
+
|
|
1074
|
+
> <SfvbI18nLanguagesResponse> disable_sfvb_i18n_language(storefront_oid, code, if_match)
|
|
1075
|
+
|
|
1076
|
+
Disable a language
|
|
1077
|
+
|
|
1078
|
+
Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
### Examples
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
(No example for this operation).
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
#### Using the disable_sfvb_i18n_language_with_http_info variant
|
|
1088
|
+
|
|
1089
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1090
|
+
|
|
1091
|
+
> <Array(<SfvbI18nLanguagesResponse>, Integer, Hash)> disable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match)
|
|
1092
|
+
|
|
1093
|
+
```ruby
|
|
1094
|
+
begin
|
|
1095
|
+
# Disable a language
|
|
1096
|
+
data, status_code, headers = api_instance.disable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match)
|
|
1097
|
+
p status_code # => 2xx
|
|
1098
|
+
p headers # => { ... }
|
|
1099
|
+
p data # => <SfvbI18nLanguagesResponse>
|
|
1100
|
+
rescue UltracartClient::ApiError => e
|
|
1101
|
+
puts "Error when calling SfvbApi->disable_sfvb_i18n_language_with_http_info: #{e}"
|
|
1102
|
+
end
|
|
1103
|
+
```
|
|
1104
|
+
|
|
1105
|
+
### Parameters
|
|
1106
|
+
|
|
1107
|
+
| Name | Type | Description | Notes |
|
|
1108
|
+
| ---- | ---- | ----------- | ----- |
|
|
1109
|
+
| **storefront_oid** | **Integer** | | |
|
|
1110
|
+
| **code** | **String** | | |
|
|
1111
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1112
|
+
|
|
1113
|
+
### Return type
|
|
1114
|
+
|
|
1115
|
+
[**SfvbI18nLanguagesResponse**](SfvbI18nLanguagesResponse.md)
|
|
1116
|
+
|
|
1117
|
+
### Authorization
|
|
1118
|
+
|
|
1119
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1120
|
+
|
|
1121
|
+
### HTTP request headers
|
|
1122
|
+
|
|
1123
|
+
- **Content-Type**: Not defined
|
|
1124
|
+
- **Accept**: application/json
|
|
1125
|
+
|
|
1126
|
+
|
|
1061
1127
|
## disable_sfvb_upsell_offer
|
|
1062
1128
|
|
|
1063
1129
|
> <SfvbUpsellOffer> disable_sfvb_upsell_offer(storefront_oid, upsell_offer_oid)
|
|
@@ -1493,6 +1559,62 @@ end
|
|
|
1493
1559
|
- **Accept**: application/json
|
|
1494
1560
|
|
|
1495
1561
|
|
|
1562
|
+
## enable_sfvb_i18n_language
|
|
1563
|
+
|
|
1564
|
+
> <SfvbI18nLanguagesResponse> enable_sfvb_i18n_language(storefront_oid, code, if_match, language_enable_request)
|
|
1565
|
+
|
|
1566
|
+
Enable a language
|
|
1567
|
+
|
|
1568
|
+
Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
### Examples
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
(No example for this operation).
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
#### Using the enable_sfvb_i18n_language_with_http_info variant
|
|
1578
|
+
|
|
1579
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1580
|
+
|
|
1581
|
+
> <Array(<SfvbI18nLanguagesResponse>, Integer, Hash)> enable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, language_enable_request)
|
|
1582
|
+
|
|
1583
|
+
```ruby
|
|
1584
|
+
begin
|
|
1585
|
+
# Enable a language
|
|
1586
|
+
data, status_code, headers = api_instance.enable_sfvb_i18n_language_with_http_info(storefront_oid, code, if_match, language_enable_request)
|
|
1587
|
+
p status_code # => 2xx
|
|
1588
|
+
p headers # => { ... }
|
|
1589
|
+
p data # => <SfvbI18nLanguagesResponse>
|
|
1590
|
+
rescue UltracartClient::ApiError => e
|
|
1591
|
+
puts "Error when calling SfvbApi->enable_sfvb_i18n_language_with_http_info: #{e}"
|
|
1592
|
+
end
|
|
1593
|
+
```
|
|
1594
|
+
|
|
1595
|
+
### Parameters
|
|
1596
|
+
|
|
1597
|
+
| Name | Type | Description | Notes |
|
|
1598
|
+
| ---- | ---- | ----------- | ----- |
|
|
1599
|
+
| **storefront_oid** | **Integer** | | |
|
|
1600
|
+
| **code** | **String** | | |
|
|
1601
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1602
|
+
| **language_enable_request** | [**SfvbI18nLanguageEnableRequest**](SfvbI18nLanguageEnableRequest.md) | The cost acknowledgement | |
|
|
1603
|
+
|
|
1604
|
+
### Return type
|
|
1605
|
+
|
|
1606
|
+
[**SfvbI18nLanguagesResponse**](SfvbI18nLanguagesResponse.md)
|
|
1607
|
+
|
|
1608
|
+
### Authorization
|
|
1609
|
+
|
|
1610
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1611
|
+
|
|
1612
|
+
### HTTP request headers
|
|
1613
|
+
|
|
1614
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1615
|
+
- **Accept**: application/json
|
|
1616
|
+
|
|
1617
|
+
|
|
1496
1618
|
## end_sfvb_experiment
|
|
1497
1619
|
|
|
1498
1620
|
> <SfvbExperiment> end_sfvb_experiment(storefront_oid, experiment_oid, opts)
|
|
@@ -2090,6 +2212,278 @@ end
|
|
|
2090
2212
|
- **Accept**: application/json
|
|
2091
2213
|
|
|
2092
2214
|
|
|
2215
|
+
## get_sfvb_i18n_glossary
|
|
2216
|
+
|
|
2217
|
+
> <SfvbI18nGlossary> get_sfvb_i18n_glossary(storefront_oid)
|
|
2218
|
+
|
|
2219
|
+
Read the storefront's translation glossary
|
|
2220
|
+
|
|
2221
|
+
The storefront's glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
### Examples
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
(No example for this operation).
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
#### Using the get_sfvb_i18n_glossary_with_http_info variant
|
|
2231
|
+
|
|
2232
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2233
|
+
|
|
2234
|
+
> <Array(<SfvbI18nGlossary>, Integer, Hash)> get_sfvb_i18n_glossary_with_http_info(storefront_oid)
|
|
2235
|
+
|
|
2236
|
+
```ruby
|
|
2237
|
+
begin
|
|
2238
|
+
# Read the storefront's translation glossary
|
|
2239
|
+
data, status_code, headers = api_instance.get_sfvb_i18n_glossary_with_http_info(storefront_oid)
|
|
2240
|
+
p status_code # => 2xx
|
|
2241
|
+
p headers # => { ... }
|
|
2242
|
+
p data # => <SfvbI18nGlossary>
|
|
2243
|
+
rescue UltracartClient::ApiError => e
|
|
2244
|
+
puts "Error when calling SfvbApi->get_sfvb_i18n_glossary_with_http_info: #{e}"
|
|
2245
|
+
end
|
|
2246
|
+
```
|
|
2247
|
+
|
|
2248
|
+
### Parameters
|
|
2249
|
+
|
|
2250
|
+
| Name | Type | Description | Notes |
|
|
2251
|
+
| ---- | ---- | ----------- | ----- |
|
|
2252
|
+
| **storefront_oid** | **Integer** | | |
|
|
2253
|
+
|
|
2254
|
+
### Return type
|
|
2255
|
+
|
|
2256
|
+
[**SfvbI18nGlossary**](SfvbI18nGlossary.md)
|
|
2257
|
+
|
|
2258
|
+
### Authorization
|
|
2259
|
+
|
|
2260
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2261
|
+
|
|
2262
|
+
### HTTP request headers
|
|
2263
|
+
|
|
2264
|
+
- **Content-Type**: Not defined
|
|
2265
|
+
- **Accept**: application/json
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
## get_sfvb_i18n_languages
|
|
2269
|
+
|
|
2270
|
+
> <SfvbI18nLanguagesResponse> get_sfvb_i18n_languages(storefront_oid)
|
|
2271
|
+
|
|
2272
|
+
List a storefront's languages
|
|
2273
|
+
|
|
2274
|
+
Every language the storefront can be translated into, with UltraCart's three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
### Examples
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
(No example for this operation).
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
#### Using the get_sfvb_i18n_languages_with_http_info variant
|
|
2284
|
+
|
|
2285
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2286
|
+
|
|
2287
|
+
> <Array(<SfvbI18nLanguagesResponse>, Integer, Hash)> get_sfvb_i18n_languages_with_http_info(storefront_oid)
|
|
2288
|
+
|
|
2289
|
+
```ruby
|
|
2290
|
+
begin
|
|
2291
|
+
# List a storefront's languages
|
|
2292
|
+
data, status_code, headers = api_instance.get_sfvb_i18n_languages_with_http_info(storefront_oid)
|
|
2293
|
+
p status_code # => 2xx
|
|
2294
|
+
p headers # => { ... }
|
|
2295
|
+
p data # => <SfvbI18nLanguagesResponse>
|
|
2296
|
+
rescue UltracartClient::ApiError => e
|
|
2297
|
+
puts "Error when calling SfvbApi->get_sfvb_i18n_languages_with_http_info: #{e}"
|
|
2298
|
+
end
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
### Parameters
|
|
2302
|
+
|
|
2303
|
+
| Name | Type | Description | Notes |
|
|
2304
|
+
| ---- | ---- | ----------- | ----- |
|
|
2305
|
+
| **storefront_oid** | **Integer** | | |
|
|
2306
|
+
|
|
2307
|
+
### Return type
|
|
2308
|
+
|
|
2309
|
+
[**SfvbI18nLanguagesResponse**](SfvbI18nLanguagesResponse.md)
|
|
2310
|
+
|
|
2311
|
+
### Authorization
|
|
2312
|
+
|
|
2313
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2314
|
+
|
|
2315
|
+
### HTTP request headers
|
|
2316
|
+
|
|
2317
|
+
- **Content-Type**: Not defined
|
|
2318
|
+
- **Accept**: application/json
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
## get_sfvb_i18n_machine_translations
|
|
2322
|
+
|
|
2323
|
+
> <SfvbI18nMachineTranslationsResponse> get_sfvb_i18n_machine_translations(storefront_oid, opts)
|
|
2324
|
+
|
|
2325
|
+
Read where a widget setting's translations come from
|
|
2326
|
+
|
|
2327
|
+
For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language's text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
### Examples
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
(No example for this operation).
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
#### Using the get_sfvb_i18n_machine_translations_with_http_info variant
|
|
2337
|
+
|
|
2338
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2339
|
+
|
|
2340
|
+
> <Array(<SfvbI18nMachineTranslationsResponse>, Integer, Hash)> get_sfvb_i18n_machine_translations_with_http_info(storefront_oid, opts)
|
|
2341
|
+
|
|
2342
|
+
```ruby
|
|
2343
|
+
begin
|
|
2344
|
+
# Read where a widget setting's translations come from
|
|
2345
|
+
data, status_code, headers = api_instance.get_sfvb_i18n_machine_translations_with_http_info(storefront_oid, opts)
|
|
2346
|
+
p status_code # => 2xx
|
|
2347
|
+
p headers # => { ... }
|
|
2348
|
+
p data # => <SfvbI18nMachineTranslationsResponse>
|
|
2349
|
+
rescue UltracartClient::ApiError => e
|
|
2350
|
+
puts "Error when calling SfvbApi->get_sfvb_i18n_machine_translations_with_http_info: #{e}"
|
|
2351
|
+
end
|
|
2352
|
+
```
|
|
2353
|
+
|
|
2354
|
+
### Parameters
|
|
2355
|
+
|
|
2356
|
+
| Name | Type | Description | Notes |
|
|
2357
|
+
| ---- | ---- | ----------- | ----- |
|
|
2358
|
+
| **storefront_oid** | **Integer** | | |
|
|
2359
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
2360
|
+
| **widget_id** | **String** | | [optional] |
|
|
2361
|
+
| **property** | **String** | | [optional] |
|
|
2362
|
+
|
|
2363
|
+
### Return type
|
|
2364
|
+
|
|
2365
|
+
[**SfvbI18nMachineTranslationsResponse**](SfvbI18nMachineTranslationsResponse.md)
|
|
2366
|
+
|
|
2367
|
+
### Authorization
|
|
2368
|
+
|
|
2369
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2370
|
+
|
|
2371
|
+
### HTTP request headers
|
|
2372
|
+
|
|
2373
|
+
- **Content-Type**: Not defined
|
|
2374
|
+
- **Accept**: application/json
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
## get_sfvb_i18n_message
|
|
2378
|
+
|
|
2379
|
+
> <SfvbI18nMessage> get_sfvb_i18n_message(storefront_oid, key, opts)
|
|
2380
|
+
|
|
2381
|
+
Read one built-in message
|
|
2382
|
+
|
|
2383
|
+
One message by key, with the hash_sha256 a set or reset sends back.
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
### Examples
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
(No example for this operation).
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
#### Using the get_sfvb_i18n_message_with_http_info variant
|
|
2393
|
+
|
|
2394
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2395
|
+
|
|
2396
|
+
> <Array(<SfvbI18nMessage>, Integer, Hash)> get_sfvb_i18n_message_with_http_info(storefront_oid, key, opts)
|
|
2397
|
+
|
|
2398
|
+
```ruby
|
|
2399
|
+
begin
|
|
2400
|
+
# Read one built-in message
|
|
2401
|
+
data, status_code, headers = api_instance.get_sfvb_i18n_message_with_http_info(storefront_oid, key, opts)
|
|
2402
|
+
p status_code # => 2xx
|
|
2403
|
+
p headers # => { ... }
|
|
2404
|
+
p data # => <SfvbI18nMessage>
|
|
2405
|
+
rescue UltracartClient::ApiError => e
|
|
2406
|
+
puts "Error when calling SfvbApi->get_sfvb_i18n_message_with_http_info: #{e}"
|
|
2407
|
+
end
|
|
2408
|
+
```
|
|
2409
|
+
|
|
2410
|
+
### Parameters
|
|
2411
|
+
|
|
2412
|
+
| Name | Type | Description | Notes |
|
|
2413
|
+
| ---- | ---- | ----------- | ----- |
|
|
2414
|
+
| **storefront_oid** | **Integer** | | |
|
|
2415
|
+
| **key** | **String** | | |
|
|
2416
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
2417
|
+
|
|
2418
|
+
### Return type
|
|
2419
|
+
|
|
2420
|
+
[**SfvbI18nMessage**](SfvbI18nMessage.md)
|
|
2421
|
+
|
|
2422
|
+
### Authorization
|
|
2423
|
+
|
|
2424
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2425
|
+
|
|
2426
|
+
### HTTP request headers
|
|
2427
|
+
|
|
2428
|
+
- **Content-Type**: Not defined
|
|
2429
|
+
- **Accept**: application/json
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
## get_sfvb_i18n_message_machine_translations
|
|
2433
|
+
|
|
2434
|
+
> <SfvbI18nMachineTranslationsResponse> get_sfvb_i18n_message_machine_translations(storefront_oid, key, opts)
|
|
2435
|
+
|
|
2436
|
+
Read where a message's translations come from
|
|
2437
|
+
|
|
2438
|
+
For one message, each enabled language's text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
|
|
2439
|
+
|
|
2440
|
+
|
|
2441
|
+
### Examples
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
(No example for this operation).
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
#### Using the get_sfvb_i18n_message_machine_translations_with_http_info variant
|
|
2448
|
+
|
|
2449
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2450
|
+
|
|
2451
|
+
> <Array(<SfvbI18nMachineTranslationsResponse>, Integer, Hash)> get_sfvb_i18n_message_machine_translations_with_http_info(storefront_oid, key, opts)
|
|
2452
|
+
|
|
2453
|
+
```ruby
|
|
2454
|
+
begin
|
|
2455
|
+
# Read where a message's translations come from
|
|
2456
|
+
data, status_code, headers = api_instance.get_sfvb_i18n_message_machine_translations_with_http_info(storefront_oid, key, opts)
|
|
2457
|
+
p status_code # => 2xx
|
|
2458
|
+
p headers # => { ... }
|
|
2459
|
+
p data # => <SfvbI18nMachineTranslationsResponse>
|
|
2460
|
+
rescue UltracartClient::ApiError => e
|
|
2461
|
+
puts "Error when calling SfvbApi->get_sfvb_i18n_message_machine_translations_with_http_info: #{e}"
|
|
2462
|
+
end
|
|
2463
|
+
```
|
|
2464
|
+
|
|
2465
|
+
### Parameters
|
|
2466
|
+
|
|
2467
|
+
| Name | Type | Description | Notes |
|
|
2468
|
+
| ---- | ---- | ----------- | ----- |
|
|
2469
|
+
| **storefront_oid** | **Integer** | | |
|
|
2470
|
+
| **key** | **String** | | |
|
|
2471
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
2472
|
+
|
|
2473
|
+
### Return type
|
|
2474
|
+
|
|
2475
|
+
[**SfvbI18nMachineTranslationsResponse**](SfvbI18nMachineTranslationsResponse.md)
|
|
2476
|
+
|
|
2477
|
+
### Authorization
|
|
2478
|
+
|
|
2479
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2480
|
+
|
|
2481
|
+
### HTTP request headers
|
|
2482
|
+
|
|
2483
|
+
- **Content-Type**: Not defined
|
|
2484
|
+
- **Accept**: application/json
|
|
2485
|
+
|
|
2486
|
+
|
|
2093
2487
|
## get_sfvb_item
|
|
2094
2488
|
|
|
2095
2489
|
> <SfvbItemResponse> get_sfvb_item(storefront_oid, opts)
|
|
@@ -3987,6 +4381,65 @@ end
|
|
|
3987
4381
|
- **Accept**: application/json
|
|
3988
4382
|
|
|
3989
4383
|
|
|
4384
|
+
## list_sfvb_i18n_messages
|
|
4385
|
+
|
|
4386
|
+
> <SfvbI18nMessagesResponse> list_sfvb_i18n_messages(storefront_oid, opts)
|
|
4387
|
+
|
|
4388
|
+
List built-in messages
|
|
4389
|
+
|
|
4390
|
+
The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language's text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
4391
|
+
|
|
4392
|
+
|
|
4393
|
+
### Examples
|
|
4394
|
+
|
|
4395
|
+
|
|
4396
|
+
(No example for this operation).
|
|
4397
|
+
|
|
4398
|
+
|
|
4399
|
+
#### Using the list_sfvb_i18n_messages_with_http_info variant
|
|
4400
|
+
|
|
4401
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4402
|
+
|
|
4403
|
+
> <Array(<SfvbI18nMessagesResponse>, Integer, Hash)> list_sfvb_i18n_messages_with_http_info(storefront_oid, opts)
|
|
4404
|
+
|
|
4405
|
+
```ruby
|
|
4406
|
+
begin
|
|
4407
|
+
# List built-in messages
|
|
4408
|
+
data, status_code, headers = api_instance.list_sfvb_i18n_messages_with_http_info(storefront_oid, opts)
|
|
4409
|
+
p status_code # => 2xx
|
|
4410
|
+
p headers # => { ... }
|
|
4411
|
+
p data # => <SfvbI18nMessagesResponse>
|
|
4412
|
+
rescue UltracartClient::ApiError => e
|
|
4413
|
+
puts "Error when calling SfvbApi->list_sfvb_i18n_messages_with_http_info: #{e}"
|
|
4414
|
+
end
|
|
4415
|
+
```
|
|
4416
|
+
|
|
4417
|
+
### Parameters
|
|
4418
|
+
|
|
4419
|
+
| Name | Type | Description | Notes |
|
|
4420
|
+
| ---- | ---- | ----------- | ----- |
|
|
4421
|
+
| **storefront_oid** | **Integer** | | |
|
|
4422
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
4423
|
+
| **q** | **String** | | [optional] |
|
|
4424
|
+
| **language** | **String** | | [optional] |
|
|
4425
|
+
| **overridden** | **Boolean** | | [optional] |
|
|
4426
|
+
| **offset** | **Integer** | | [optional] |
|
|
4427
|
+
| **limit** | **Integer** | | [optional] |
|
|
4428
|
+
|
|
4429
|
+
### Return type
|
|
4430
|
+
|
|
4431
|
+
[**SfvbI18nMessagesResponse**](SfvbI18nMessagesResponse.md)
|
|
4432
|
+
|
|
4433
|
+
### Authorization
|
|
4434
|
+
|
|
4435
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4436
|
+
|
|
4437
|
+
### HTTP request headers
|
|
4438
|
+
|
|
4439
|
+
- **Content-Type**: Not defined
|
|
4440
|
+
- **Accept**: application/json
|
|
4441
|
+
|
|
4442
|
+
|
|
3990
4443
|
## list_sfvb_item_containers
|
|
3991
4444
|
|
|
3992
4445
|
> <SfvbItemContainersResponse> list_sfvb_item_containers(storefront_oid, opts)
|
|
@@ -4765,6 +5218,118 @@ end
|
|
|
4765
5218
|
- **Accept**: application/json
|
|
4766
5219
|
|
|
4767
5220
|
|
|
5221
|
+
## put_sfvb_i18n_glossary
|
|
5222
|
+
|
|
5223
|
+
> <SfvbI18nGlossary> put_sfvb_i18n_glossary(storefront_oid, glossary_request, opts)
|
|
5224
|
+
|
|
5225
|
+
Replace the storefront's translation glossary
|
|
5226
|
+
|
|
5227
|
+
Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
|
|
5228
|
+
|
|
5229
|
+
|
|
5230
|
+
### Examples
|
|
5231
|
+
|
|
5232
|
+
|
|
5233
|
+
(No example for this operation).
|
|
5234
|
+
|
|
5235
|
+
|
|
5236
|
+
#### Using the put_sfvb_i18n_glossary_with_http_info variant
|
|
5237
|
+
|
|
5238
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5239
|
+
|
|
5240
|
+
> <Array(<SfvbI18nGlossary>, Integer, Hash)> put_sfvb_i18n_glossary_with_http_info(storefront_oid, glossary_request, opts)
|
|
5241
|
+
|
|
5242
|
+
```ruby
|
|
5243
|
+
begin
|
|
5244
|
+
# Replace the storefront's translation glossary
|
|
5245
|
+
data, status_code, headers = api_instance.put_sfvb_i18n_glossary_with_http_info(storefront_oid, glossary_request, opts)
|
|
5246
|
+
p status_code # => 2xx
|
|
5247
|
+
p headers # => { ... }
|
|
5248
|
+
p data # => <SfvbI18nGlossary>
|
|
5249
|
+
rescue UltracartClient::ApiError => e
|
|
5250
|
+
puts "Error when calling SfvbApi->put_sfvb_i18n_glossary_with_http_info: #{e}"
|
|
5251
|
+
end
|
|
5252
|
+
```
|
|
5253
|
+
|
|
5254
|
+
### Parameters
|
|
5255
|
+
|
|
5256
|
+
| Name | Type | Description | Notes |
|
|
5257
|
+
| ---- | ---- | ----------- | ----- |
|
|
5258
|
+
| **storefront_oid** | **Integer** | | |
|
|
5259
|
+
| **glossary_request** | [**SfvbI18nGlossaryRequest**](SfvbI18nGlossaryRequest.md) | The glossary | |
|
|
5260
|
+
| **if_match** | **String** | hash_sha256 from the last read. Not needed for the first save; otherwise 428 when absent, 412 when stale. | [optional] |
|
|
5261
|
+
|
|
5262
|
+
### Return type
|
|
5263
|
+
|
|
5264
|
+
[**SfvbI18nGlossary**](SfvbI18nGlossary.md)
|
|
5265
|
+
|
|
5266
|
+
### Authorization
|
|
5267
|
+
|
|
5268
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5269
|
+
|
|
5270
|
+
### HTTP request headers
|
|
5271
|
+
|
|
5272
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5273
|
+
- **Accept**: application/json
|
|
5274
|
+
|
|
5275
|
+
|
|
5276
|
+
## put_sfvb_i18n_message
|
|
5277
|
+
|
|
5278
|
+
> <SfvbI18nMessage> put_sfvb_i18n_message(storefront_oid, key, if_match, message_write_request, opts)
|
|
5279
|
+
|
|
5280
|
+
Change one built-in message
|
|
5281
|
+
|
|
5282
|
+
Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone; empty text is refused. Shoppers see it at once. Always needs sfvb_publish.
|
|
5283
|
+
|
|
5284
|
+
|
|
5285
|
+
### Examples
|
|
5286
|
+
|
|
5287
|
+
|
|
5288
|
+
(No example for this operation).
|
|
5289
|
+
|
|
5290
|
+
|
|
5291
|
+
#### Using the put_sfvb_i18n_message_with_http_info variant
|
|
5292
|
+
|
|
5293
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5294
|
+
|
|
5295
|
+
> <Array(<SfvbI18nMessage>, Integer, Hash)> put_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, message_write_request, opts)
|
|
5296
|
+
|
|
5297
|
+
```ruby
|
|
5298
|
+
begin
|
|
5299
|
+
# Change one built-in message
|
|
5300
|
+
data, status_code, headers = api_instance.put_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, message_write_request, opts)
|
|
5301
|
+
p status_code # => 2xx
|
|
5302
|
+
p headers # => { ... }
|
|
5303
|
+
p data # => <SfvbI18nMessage>
|
|
5304
|
+
rescue UltracartClient::ApiError => e
|
|
5305
|
+
puts "Error when calling SfvbApi->put_sfvb_i18n_message_with_http_info: #{e}"
|
|
5306
|
+
end
|
|
5307
|
+
```
|
|
5308
|
+
|
|
5309
|
+
### Parameters
|
|
5310
|
+
|
|
5311
|
+
| Name | Type | Description | Notes |
|
|
5312
|
+
| ---- | ---- | ----------- | ----- |
|
|
5313
|
+
| **storefront_oid** | **Integer** | | |
|
|
5314
|
+
| **key** | **String** | | |
|
|
5315
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
5316
|
+
| **message_write_request** | [**SfvbI18nMessageWriteRequest**](SfvbI18nMessageWriteRequest.md) | The languages to change | |
|
|
5317
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
5318
|
+
|
|
5319
|
+
### Return type
|
|
5320
|
+
|
|
5321
|
+
[**SfvbI18nMessage**](SfvbI18nMessage.md)
|
|
5322
|
+
|
|
5323
|
+
### Authorization
|
|
5324
|
+
|
|
5325
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5326
|
+
|
|
5327
|
+
### HTTP request headers
|
|
5328
|
+
|
|
5329
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5330
|
+
- **Accept**: application/json
|
|
5331
|
+
|
|
5332
|
+
|
|
4768
5333
|
## put_sfvb_item_attributes
|
|
4769
5334
|
|
|
4770
5335
|
> <SfvbItemResponse> put_sfvb_item_attributes(storefront_oid, item_attribute_update_request, opts)
|
|
@@ -5757,6 +6322,62 @@ end
|
|
|
5757
6322
|
- **Accept**: application/json
|
|
5758
6323
|
|
|
5759
6324
|
|
|
6325
|
+
## reset_sfvb_i18n_message
|
|
6326
|
+
|
|
6327
|
+
> <SfvbI18nResetResponse> reset_sfvb_i18n_message(storefront_oid, key, if_match, opts)
|
|
6328
|
+
|
|
6329
|
+
Reset one built-in message
|
|
6330
|
+
|
|
6331
|
+
Puts a message back to the template's text. The merchant's English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme's locale file is refused. Always needs sfvb_publish.
|
|
6332
|
+
|
|
6333
|
+
|
|
6334
|
+
### Examples
|
|
6335
|
+
|
|
6336
|
+
|
|
6337
|
+
(No example for this operation).
|
|
6338
|
+
|
|
6339
|
+
|
|
6340
|
+
#### Using the reset_sfvb_i18n_message_with_http_info variant
|
|
6341
|
+
|
|
6342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6343
|
+
|
|
6344
|
+
> <Array(<SfvbI18nResetResponse>, Integer, Hash)> reset_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, opts)
|
|
6345
|
+
|
|
6346
|
+
```ruby
|
|
6347
|
+
begin
|
|
6348
|
+
# Reset one built-in message
|
|
6349
|
+
data, status_code, headers = api_instance.reset_sfvb_i18n_message_with_http_info(storefront_oid, key, if_match, opts)
|
|
6350
|
+
p status_code # => 2xx
|
|
6351
|
+
p headers # => { ... }
|
|
6352
|
+
p data # => <SfvbI18nResetResponse>
|
|
6353
|
+
rescue UltracartClient::ApiError => e
|
|
6354
|
+
puts "Error when calling SfvbApi->reset_sfvb_i18n_message_with_http_info: #{e}"
|
|
6355
|
+
end
|
|
6356
|
+
```
|
|
6357
|
+
|
|
6358
|
+
### Parameters
|
|
6359
|
+
|
|
6360
|
+
| Name | Type | Description | Notes |
|
|
6361
|
+
| ---- | ---- | ----------- | ----- |
|
|
6362
|
+
| **storefront_oid** | **Integer** | | |
|
|
6363
|
+
| **key** | **String** | | |
|
|
6364
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
6365
|
+
| **theme_oid** | **Integer** | | [optional] |
|
|
6366
|
+
|
|
6367
|
+
### Return type
|
|
6368
|
+
|
|
6369
|
+
[**SfvbI18nResetResponse**](SfvbI18nResetResponse.md)
|
|
6370
|
+
|
|
6371
|
+
### Authorization
|
|
6372
|
+
|
|
6373
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6374
|
+
|
|
6375
|
+
### HTTP request headers
|
|
6376
|
+
|
|
6377
|
+
- **Content-Type**: Not defined
|
|
6378
|
+
- **Accept**: application/json
|
|
6379
|
+
|
|
6380
|
+
|
|
5760
6381
|
## resolve_sfvb_template
|
|
5761
6382
|
|
|
5762
6383
|
> <SfvbTemplateResolveResponse> resolve_sfvb_template(storefront_oid, name, opts)
|