ultracart_api 4.1.152 → 4.1.153
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 +13 -2
- data/docs/SfvbApi.md +224 -0
- data/docs/SfvbPageAttribute.md +32 -0
- data/docs/SfvbPageAttributeUpdate.md +22 -0
- data/docs/SfvbPageAttributeUpdateRequest.md +18 -0
- data/docs/SfvbPageMultimedia.md +30 -0
- data/docs/SfvbPageMultimediaRequest.md +24 -0
- data/docs/SfvbPageResponse.md +22 -0
- data/lib/ultracart_api/api/sfvb_api.rb +312 -0
- data/lib/ultracart_api/models/sfvb_page_attribute.rb +324 -0
- data/lib/ultracart_api/models/sfvb_page_attribute_update.rb +274 -0
- data/lib/ultracart_api/models/sfvb_page_attribute_update_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_page_multimedia.rb +280 -0
- data/lib/ultracart_api/models/sfvb_page_multimedia_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_page_response.rb +244 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2e85ec4d8c8f205c28e0eb38c7542fc901b7de62a315a4d7dcca2c58aab386b0
|
|
4
|
+
data.tar.gz: f750082b045c19460b77dae4330a936d37c16b30ea51e08b8961dff9c4c9a8bd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 66fa2b4121de7d02ebef906981fd45076568e382c06e4a69b543969725b76d73d361051339954dd5ffef182bc028917cacc7847883b4861f799c83ce45f88a67
|
|
7
|
+
data.tar.gz: d2c6ca8f0f88fd02379c5dc102b26578ddda34ab62a4dddc294d2174edb1340011a51c5115c8d04e8cc868ef437cfd6d8d91e5deae7c28982422724b5fdaa8c1
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.153
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.153'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -475,6 +475,7 @@ Class | Method | HTTP request | Description
|
|
|
475
475
|
*UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
|
|
476
476
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
477
477
|
*UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
|
|
478
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
|
|
478
479
|
*UltracartClient::SfvbApi* | [**delete_sfvb_preview_session**](docs/SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session
|
|
479
480
|
*UltracartClient::SfvbApi* | [**download_sfvb_file**](docs/SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes
|
|
480
481
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_theme**](docs/SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme
|
|
@@ -485,6 +486,7 @@ Class | Method | HTTP request | Description
|
|
|
485
486
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
486
487
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/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
|
|
487
488
|
*UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
|
|
489
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_page**](docs/SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images
|
|
488
490
|
*UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
|
|
489
491
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
490
492
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
|
|
@@ -501,6 +503,8 @@ Class | Method | HTTP request | Description
|
|
|
501
503
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
|
|
502
504
|
*UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
|
|
503
505
|
*UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
|
|
506
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_page_attributes**](docs/SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes
|
|
507
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_page_multimedia**](docs/SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page
|
|
504
508
|
*UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
|
|
505
509
|
*UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
|
|
506
510
|
*UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
|
|
@@ -1754,6 +1758,12 @@ Class | Method | HTTP request | Description
|
|
|
1754
1758
|
- [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
|
|
1755
1759
|
- [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
|
|
1756
1760
|
- [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
|
|
1761
|
+
- [UltracartClient::SfvbPageAttribute](docs/SfvbPageAttribute.md)
|
|
1762
|
+
- [UltracartClient::SfvbPageAttributeUpdate](docs/SfvbPageAttributeUpdate.md)
|
|
1763
|
+
- [UltracartClient::SfvbPageAttributeUpdateRequest](docs/SfvbPageAttributeUpdateRequest.md)
|
|
1764
|
+
- [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
|
|
1765
|
+
- [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
|
|
1766
|
+
- [UltracartClient::SfvbPageResponse](docs/SfvbPageResponse.md)
|
|
1757
1767
|
- [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
|
|
1758
1768
|
- [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
|
|
1759
1769
|
- [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
|
|
@@ -1942,6 +1952,7 @@ Not every change is committed to every SDK.
|
|
|
1942
1952
|
|
|
1943
1953
|
| Version | Date | Comments |
|
|
1944
1954
|
| --: | :-: | --- |
|
|
1955
|
+
| 4.1.153 | 09/14/2026 | sfvb internal testing |
|
|
1945
1956
|
| 4.1.152 | 09/09/2026 | sfvb - internal testing |
|
|
1946
1957
|
| 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |
|
|
1947
1958
|
| 4.1.150 | 09/04/2026 | conversations - add ai agent capabilities |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
7
7
|
| [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
|
|
8
8
|
| [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
|
|
9
9
|
| [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
|
|
10
|
+
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
10
11
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
11
12
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
12
13
|
| [**duplicate_sfvb_theme**](SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme |
|
|
@@ -17,6 +18,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
17
18
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
18
19
|
| [**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 |
|
|
19
20
|
| [**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 |
|
|
21
|
+
| [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
|
|
20
22
|
| [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
|
|
21
23
|
| [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
|
|
22
24
|
| [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
|
|
@@ -33,6 +35,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
33
35
|
| [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
|
|
34
36
|
| [**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 |
|
|
35
37
|
| [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
|
|
38
|
+
| [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
|
|
39
|
+
| [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
|
|
36
40
|
| [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
|
|
37
41
|
| [**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 |
|
|
38
42
|
| [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
|
|
@@ -207,6 +211,62 @@ nil (empty response body)
|
|
|
207
211
|
- **Accept**: application/json
|
|
208
212
|
|
|
209
213
|
|
|
214
|
+
## delete_sfvb_page_multimedia
|
|
215
|
+
|
|
216
|
+
> <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
|
|
217
|
+
|
|
218
|
+
Detach an image from a page
|
|
219
|
+
|
|
220
|
+
Name exactly one of code or default. Removes the page's copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
### Examples
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
(No example for this operation).
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
#### Using the delete_sfvb_page_multimedia_with_http_info variant
|
|
230
|
+
|
|
231
|
+
This returns an Array which contains the response data, status code and headers.
|
|
232
|
+
|
|
233
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts)
|
|
234
|
+
|
|
235
|
+
```ruby
|
|
236
|
+
begin
|
|
237
|
+
# Detach an image from a page
|
|
238
|
+
data, status_code, headers = api_instance.delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts)
|
|
239
|
+
p status_code # => 2xx
|
|
240
|
+
p headers # => { ... }
|
|
241
|
+
p data # => <SfvbPageResponse>
|
|
242
|
+
rescue UltracartClient::ApiError => e
|
|
243
|
+
puts "Error when calling SfvbApi->delete_sfvb_page_multimedia_with_http_info: #{e}"
|
|
244
|
+
end
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
|
|
249
|
+
| Name | Type | Description | Notes |
|
|
250
|
+
| ---- | ---- | ----------- | ----- |
|
|
251
|
+
| **storefront_oid** | **Integer** | | |
|
|
252
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/ | |
|
|
253
|
+
| **code** | **String** | Image code to detach | [optional] |
|
|
254
|
+
| **default** | **Boolean** | True to detach the default image | [optional] |
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
[**SfvbPageResponse**](SfvbPageResponse.md)
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
210
270
|
## delete_sfvb_preview_session
|
|
211
271
|
|
|
212
272
|
> delete_sfvb_preview_session(storefront_oid, preview_session_id)
|
|
@@ -748,6 +808,60 @@ end
|
|
|
748
808
|
- **Accept**: application/json
|
|
749
809
|
|
|
750
810
|
|
|
811
|
+
## get_sfvb_page
|
|
812
|
+
|
|
813
|
+
> <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
|
|
814
|
+
|
|
815
|
+
Read a page's attributes and images
|
|
816
|
+
|
|
817
|
+
What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
### Examples
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
(No example for this operation).
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
#### Using the get_sfvb_page_with_http_info variant
|
|
827
|
+
|
|
828
|
+
This returns an Array which contains the response data, status code and headers.
|
|
829
|
+
|
|
830
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, path)
|
|
831
|
+
|
|
832
|
+
```ruby
|
|
833
|
+
begin
|
|
834
|
+
# Read a page's attributes and images
|
|
835
|
+
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, path)
|
|
836
|
+
p status_code # => 2xx
|
|
837
|
+
p headers # => { ... }
|
|
838
|
+
p data # => <SfvbPageResponse>
|
|
839
|
+
rescue UltracartClient::ApiError => e
|
|
840
|
+
puts "Error when calling SfvbApi->get_sfvb_page_with_http_info: #{e}"
|
|
841
|
+
end
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
| Name | Type | Description | Notes |
|
|
847
|
+
| ---- | ---- | ----------- | ----- |
|
|
848
|
+
| **storefront_oid** | **Integer** | | |
|
|
849
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/ | |
|
|
850
|
+
|
|
851
|
+
### Return type
|
|
852
|
+
|
|
853
|
+
[**SfvbPageResponse**](SfvbPageResponse.md)
|
|
854
|
+
|
|
855
|
+
### Authorization
|
|
856
|
+
|
|
857
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
858
|
+
|
|
859
|
+
### HTTP request headers
|
|
860
|
+
|
|
861
|
+
- **Content-Type**: Not defined
|
|
862
|
+
- **Accept**: application/json
|
|
863
|
+
|
|
864
|
+
|
|
751
865
|
## get_sfvb_preview_url
|
|
752
866
|
|
|
753
867
|
> <SfvbPreviewUrlResponse> get_sfvb_preview_url(storefront_oid, preview_session_id, opts)
|
|
@@ -1604,6 +1718,116 @@ end
|
|
|
1604
1718
|
- **Accept**: application/json
|
|
1605
1719
|
|
|
1606
1720
|
|
|
1721
|
+
## put_sfvb_page_attributes
|
|
1722
|
+
|
|
1723
|
+
> <SfvbPageResponse> put_sfvb_page_attributes(storefront_oid, path, page_attribute_update_request)
|
|
1724
|
+
|
|
1725
|
+
Change a page's attributes
|
|
1726
|
+
|
|
1727
|
+
A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, slider, item set, page collection and video list attributes are refused - edit those in the page editor. Always needs sfvb_publish, because a page's attributes are shared by every theme and there is no dormant copy to change instead.
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
### Examples
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
(No example for this operation).
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
#### Using the put_sfvb_page_attributes_with_http_info variant
|
|
1737
|
+
|
|
1738
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1739
|
+
|
|
1740
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request)
|
|
1741
|
+
|
|
1742
|
+
```ruby
|
|
1743
|
+
begin
|
|
1744
|
+
# Change a page's attributes
|
|
1745
|
+
data, status_code, headers = api_instance.put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request)
|
|
1746
|
+
p status_code # => 2xx
|
|
1747
|
+
p headers # => { ... }
|
|
1748
|
+
p data # => <SfvbPageResponse>
|
|
1749
|
+
rescue UltracartClient::ApiError => e
|
|
1750
|
+
puts "Error when calling SfvbApi->put_sfvb_page_attributes_with_http_info: #{e}"
|
|
1751
|
+
end
|
|
1752
|
+
```
|
|
1753
|
+
|
|
1754
|
+
### Parameters
|
|
1755
|
+
|
|
1756
|
+
| Name | Type | Description | Notes |
|
|
1757
|
+
| ---- | ---- | ----------- | ----- |
|
|
1758
|
+
| **storefront_oid** | **Integer** | | |
|
|
1759
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/ | |
|
|
1760
|
+
| **page_attribute_update_request** | [**SfvbPageAttributeUpdateRequest**](SfvbPageAttributeUpdateRequest.md) | Attributes to change | |
|
|
1761
|
+
|
|
1762
|
+
### Return type
|
|
1763
|
+
|
|
1764
|
+
[**SfvbPageResponse**](SfvbPageResponse.md)
|
|
1765
|
+
|
|
1766
|
+
### Authorization
|
|
1767
|
+
|
|
1768
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1769
|
+
|
|
1770
|
+
### HTTP request headers
|
|
1771
|
+
|
|
1772
|
+
- **Content-Type**: application/json
|
|
1773
|
+
- **Accept**: application/json
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
## put_sfvb_page_multimedia
|
|
1777
|
+
|
|
1778
|
+
> <SfvbPageResponse> put_sfvb_page_multimedia(storefront_oid, path, page_multimedia_request)
|
|
1779
|
+
|
|
1780
|
+
Attach an image to a page
|
|
1781
|
+
|
|
1782
|
+
Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code. The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows. Replaces whatever that slot held. Always needs sfvb_publish.
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
### Examples
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
(No example for this operation).
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
#### Using the put_sfvb_page_multimedia_with_http_info variant
|
|
1792
|
+
|
|
1793
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1794
|
+
|
|
1795
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request)
|
|
1796
|
+
|
|
1797
|
+
```ruby
|
|
1798
|
+
begin
|
|
1799
|
+
# Attach an image to a page
|
|
1800
|
+
data, status_code, headers = api_instance.put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request)
|
|
1801
|
+
p status_code # => 2xx
|
|
1802
|
+
p headers # => { ... }
|
|
1803
|
+
p data # => <SfvbPageResponse>
|
|
1804
|
+
rescue UltracartClient::ApiError => e
|
|
1805
|
+
puts "Error when calling SfvbApi->put_sfvb_page_multimedia_with_http_info: #{e}"
|
|
1806
|
+
end
|
|
1807
|
+
```
|
|
1808
|
+
|
|
1809
|
+
### Parameters
|
|
1810
|
+
|
|
1811
|
+
| Name | Type | Description | Notes |
|
|
1812
|
+
| ---- | ---- | ----------- | ----- |
|
|
1813
|
+
| **storefront_oid** | **Integer** | | |
|
|
1814
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/ | |
|
|
1815
|
+
| **page_multimedia_request** | [**SfvbPageMultimediaRequest**](SfvbPageMultimediaRequest.md) | Image to attach | |
|
|
1816
|
+
|
|
1817
|
+
### Return type
|
|
1818
|
+
|
|
1819
|
+
[**SfvbPageResponse**](SfvbPageResponse.md)
|
|
1820
|
+
|
|
1821
|
+
### Authorization
|
|
1822
|
+
|
|
1823
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1824
|
+
|
|
1825
|
+
### HTTP request headers
|
|
1826
|
+
|
|
1827
|
+
- **Content-Type**: application/json
|
|
1828
|
+
- **Accept**: application/json
|
|
1829
|
+
|
|
1830
|
+
|
|
1607
1831
|
## put_sfvb_preview_session
|
|
1608
1832
|
|
|
1609
1833
|
> <SfvbPreviewSessionResponse> put_sfvb_preview_session(storefront_oid, preview_session_id, preview_session, opts)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **deprecated** | **Boolean** | True when the active theme marks this attribute as on its way out. Prefer not to build on it. | [optional] |
|
|
8
|
+
| **name** | **String** | Attribute name, as the template's uc page-attribute directive spells it. Compare case insensitively. This is the value pageAttributeName refers to. | [optional] |
|
|
9
|
+
| **type** | **String** | What kind of attribute this is, taken from the template that declares it rather than from the stored row. orphan means no template declares it. reserved covers the page SEO fields. | [optional] |
|
|
10
|
+
| **undeclared** | **Boolean** | True when no template references this name. Writing such a name is allowed, but if you did not mean to create one this is a misspelling and nothing on the page will show it. | [optional] |
|
|
11
|
+
| **used_by** | **String** | The other themes that declare this attribute, when the active theme does not. | [optional] |
|
|
12
|
+
| **used_by_current_theme** | **Boolean** | True when a template in the active theme declares this attribute. | [optional] |
|
|
13
|
+
| **value** | **String** | The stored value. Empty when a template declares the attribute and nothing has set it. | [optional] |
|
|
14
|
+
| **writable** | **Boolean** | True when this API will change the value. List, slider, item set, page collection and video list values are structured documents carrying their own translation references and derived data, so they are shown here but must be edited in the page editor. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbPageAttribute.new(
|
|
22
|
+
deprecated: null,
|
|
23
|
+
name: null,
|
|
24
|
+
type: null,
|
|
25
|
+
undeclared: null,
|
|
26
|
+
used_by: null,
|
|
27
|
+
used_by_current_theme: null,
|
|
28
|
+
value: null,
|
|
29
|
+
writable: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageAttributeUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Attribute name. Matched without regard to case against what the page already has, so you do not have to reproduce the exact casing. A name nothing matches creates a new attribute. | [optional] |
|
|
8
|
+
| **type** | **String** | Only consulted when creating an attribute no template declares. For a declared attribute the template's type always wins, because the templates decide it and not the caller. | [optional] |
|
|
9
|
+
| **value** | **String** | The value to store. An empty string clears it. For html the markup is stored as given and rendered as given. For boolean send the text true or false. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbPageAttributeUpdate.new(
|
|
17
|
+
name: null,
|
|
18
|
+
type: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageAttributeUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attributes** | [**Array<SfvbPageAttributeUpdate>**](SfvbPageAttributeUpdate.md) | The attributes to change. Every entry is checked before any is written, so a request naming one attribute this API will not change writes nothing rather than part of what it asked for. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbPageAttributeUpdateRequest.new(
|
|
15
|
+
attributes: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageMultimedia
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The image code, which is what pageImageCode refers to. Empty for the default image. | [optional] |
|
|
8
|
+
| **declared** | **Boolean** | True when a template declares this code. An attached image whose code nothing declares renders nowhere unless a pageimage element names it. | [optional] |
|
|
9
|
+
| **default** | **Boolean** | True for the page's default image, which a pageimage element with no pageImageCode renders. This is the thumbnail a subgroup tile shows. | [optional] |
|
|
10
|
+
| **description** | **String** | What the slot is for, as the declaring template describes it, otherwise the description stored with the image. Rendered as the alt text. | [optional] |
|
|
11
|
+
| **dimensions** | **String** | Width x height in pixels, when the attached file is an image. | [optional] |
|
|
12
|
+
| **filename** | **String** | The attached file's name within the page's folder. Empty when nothing is attached. | [optional] |
|
|
13
|
+
| **public_url** | **String** | Where the source file is served on the storefront. Absent when nothing is attached. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::SfvbPageMultimedia.new(
|
|
21
|
+
code: null,
|
|
22
|
+
declared: null,
|
|
23
|
+
default: null,
|
|
24
|
+
description: null,
|
|
25
|
+
dimensions: null,
|
|
26
|
+
filename: null,
|
|
27
|
+
public_url: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageMultimediaRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Attach under this image code, the value a pageimage element's pageImageCode names. | [optional] |
|
|
8
|
+
| **default** | **Boolean** | True to make this the page's default image, which a pageimage element with no pageImageCode renders and a subgroup tile shows. Replaces any existing default. | [optional] |
|
|
9
|
+
| **description** | **String** | Stored with the image and rendered as its alt text. Optional. | [optional] |
|
|
10
|
+
| **filename** | **String** | Name of a raster image already stored directly in the page's folder, for example thumb.png for a file uploaded to the page path followed by thumb.png. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbPageMultimediaRequest.new(
|
|
18
|
+
code: null,
|
|
19
|
+
default: null,
|
|
20
|
+
description: null,
|
|
21
|
+
filename: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet. These are what the pageattribute element renders. Sorted by name. | [optional] |
|
|
8
|
+
| **multimedia** | [**Array<SfvbPageMultimedia>**](SfvbPageMultimedia.md) | The page's images, including codes a template declares but nothing has attached yet. These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code. The default image comes first. | [optional] |
|
|
9
|
+
| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbPageResponse.new(
|
|
17
|
+
attributes: null,
|
|
18
|
+
multimedia: null,
|
|
19
|
+
path: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|