ultracart_api 4.1.156 → 4.1.158

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4eb86992bc479fd054fc72958e6622d59bd4cb72f2dbb13f7db9e69ef2517e0e
4
- data.tar.gz: bf9953831d56669b3c62cf555be9631ec74e78bae97a83e0cbc5f67397ac8d1c
3
+ metadata.gz: 513a1f7858d7b587cc7e3a3a10f162334420eb14d48e6c933a196617dfb8d4d0
4
+ data.tar.gz: 662a2fc9835f6c43d30392f84ddbdc41c7ffe386d2ed91ee4328a4ca3b3615b7
5
5
  SHA512:
6
- metadata.gz: d28e46f9455289b3b14ae48c7a4dbe5494208704671bbd17fd9ebf11c2a31ca18ce8d2249967b0c9ee9aa4411d30eecf5e8bcd2209f0bac4a27dd808d30be23c
7
- data.tar.gz: 5292805e1e2d9213267e48623ed2fdba79e332dfcfd3b9cf7ab91b082b8f6f7cdd4bb167d8becfc655499b84c857a40f48aa7467cb07f2a77cd9bb73293d4484
6
+ metadata.gz: 687a74e8ab905d532d077f36065430c59d26db75052e9d8b072676ee75ed112d587ade949b416c2334ab29cc106f0c1f0038581bd25f354a3dc2a086d4acede9
7
+ data.tar.gz: 70d1aabfffe112e820668996fa0e756d7b73fe0ee67487672bad1ea770d360dcd54f9361f8e18620e5f3f36d032d503d72c7f863143f2278c9fe4a5bfb42ff89
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.156
10
+ - Package version: 4.1.158
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.156'
19
+ gem 'ultracart_api', '4.1.158'
20
20
  ```
21
21
 
22
22
  install:
@@ -491,6 +491,7 @@ Class | Method | HTTP request | Description
491
491
  *UltracartClient::SfvbApi* | [**get_sfvb_menus**](docs/SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus
492
492
  *UltracartClient::SfvbApi* | [**get_sfvb_page**](docs/SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images
493
493
  *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
494
+ *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
494
495
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
495
496
  *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
496
497
  *UltracartClient::SfvbApi* | [**get_sfvb_theme_job**](docs/SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job
@@ -510,6 +511,7 @@ Class | Method | HTTP request | Description
510
511
  *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
511
512
  *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
512
513
  *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
514
+ *UltracartClient::SfvbApi* | [**put_sfvb_site_attributes**](docs/SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes
513
515
  *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
514
516
  *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
515
517
  *UltracartClient::SfvbApi* | [**reserve_sfvb_widget_ids**](docs/SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids
@@ -1779,6 +1781,10 @@ Class | Method | HTTP request | Description
1779
1781
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
1780
1782
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
1781
1783
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
1784
+ - [UltracartClient::SfvbSiteAttribute](docs/SfvbSiteAttribute.md)
1785
+ - [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
1786
+ - [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
1787
+ - [UltracartClient::SfvbSiteAttributesResponse](docs/SfvbSiteAttributesResponse.md)
1782
1788
  - [UltracartClient::SfvbStorefront](docs/SfvbStorefront.md)
1783
1789
  - [UltracartClient::SfvbStorefrontsResponse](docs/SfvbStorefrontsResponse.md)
1784
1790
  - [UltracartClient::SfvbTheme](docs/SfvbTheme.md)
@@ -1962,6 +1968,8 @@ Not every change is committed to every SDK.
1962
1968
 
1963
1969
  | Version | Date | Comments |
1964
1970
  | --: | :-: | --- |
1971
+ | 4.1.158 | 09/18/2026 | sfvb internal testing |
1972
+ | 4.1.157 | 09/18/2026 | sfvb internal testing |
1965
1973
  | 4.1.156 | 09/16/2026 | sfvb internal testing |
1966
1974
  | 4.1.155 | 09/15/2026 | sfvb internal testing |
1967
1975
  | 4.1.154 | 09/14/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -23,6 +23,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
23
23
  | [**get_sfvb_menus**](SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus |
24
24
  | [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
25
25
  | [**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 |
26
+ | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
26
27
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
27
28
  | [**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 |
28
29
  | [**get_sfvb_theme_job**](SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job |
@@ -42,6 +43,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
42
43
  | [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
43
44
  | [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
44
45
  | [**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 |
46
+ | [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
45
47
  | [**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 |
46
48
  | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
47
49
  | [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
@@ -545,7 +547,7 @@ end
545
547
 
546
548
  Read a container stored outside the file system
547
549
 
548
- owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
550
+ owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
549
551
 
550
552
 
551
553
  ### Examples
@@ -601,7 +603,7 @@ end
601
603
 
602
604
  Read the CJSON stored in one container history entry
603
605
 
604
- Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
606
+ Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
605
607
 
606
608
 
607
609
  ### Examples
@@ -1084,6 +1086,59 @@ end
1084
1086
  - **Accept**: application/json
1085
1087
 
1086
1088
 
1089
+ ## get_sfvb_site_attributes
1090
+
1091
+ > <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
1092
+
1093
+ Read a storefront's site attributes
1094
+
1095
+ The values the siteattribute element and $site.attr render. These are not in any file or theme. Attributes a template declares but nothing has set are included with the template's default, so the response describes what the templates can render rather than only what has been saved. Credentials stored as site attributes are never included.
1096
+
1097
+
1098
+ ### Examples
1099
+
1100
+
1101
+ (No example for this operation).
1102
+
1103
+
1104
+ #### Using the get_sfvb_site_attributes_with_http_info variant
1105
+
1106
+ This returns an Array which contains the response data, status code and headers.
1107
+
1108
+ > <Array(<SfvbSiteAttributesResponse>, Integer, Hash)> get_sfvb_site_attributes_with_http_info(storefront_oid)
1109
+
1110
+ ```ruby
1111
+ begin
1112
+ # Read a storefront's site attributes
1113
+ data, status_code, headers = api_instance.get_sfvb_site_attributes_with_http_info(storefront_oid)
1114
+ p status_code # => 2xx
1115
+ p headers # => { ... }
1116
+ p data # => <SfvbSiteAttributesResponse>
1117
+ rescue UltracartClient::ApiError => e
1118
+ puts "Error when calling SfvbApi->get_sfvb_site_attributes_with_http_info: #{e}"
1119
+ end
1120
+ ```
1121
+
1122
+ ### Parameters
1123
+
1124
+ | Name | Type | Description | Notes |
1125
+ | ---- | ---- | ----------- | ----- |
1126
+ | **storefront_oid** | **Integer** | | |
1127
+
1128
+ ### Return type
1129
+
1130
+ [**SfvbSiteAttributesResponse**](SfvbSiteAttributesResponse.md)
1131
+
1132
+ ### Authorization
1133
+
1134
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1135
+
1136
+ ### HTTP request headers
1137
+
1138
+ - **Content-Type**: Not defined
1139
+ - **Accept**: application/json
1140
+
1141
+
1087
1142
  ## get_sfvb_theme
1088
1143
 
1089
1144
  > <SfvbTheme> get_sfvb_theme(storefront_oid, theme_oid)
@@ -1406,6 +1461,8 @@ end
1406
1461
 
1407
1462
  Version history for a container stored outside the file system
1408
1463
 
1464
+ Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
1465
+
1409
1466
 
1410
1467
  ### Examples
1411
1468
 
@@ -1777,7 +1834,7 @@ end
1777
1834
 
1778
1835
  Write a container stored outside the file system
1779
1836
 
1780
- Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
1837
+ Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
1781
1838
 
1782
1839
 
1783
1840
  ### Examples
@@ -2107,6 +2164,60 @@ end
2107
2164
  - **Accept**: application/json
2108
2165
 
2109
2166
 
2167
+ ## put_sfvb_site_attributes
2168
+
2169
+ > <SfvbSiteAttributesResponse> put_sfvb_site_attributes(storefront_oid, site_attribute_update_request)
2170
+
2171
+ Change a storefront's site attributes
2172
+
2173
+ A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names. Credentials are refused. Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead. The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
2174
+
2175
+
2176
+ ### Examples
2177
+
2178
+
2179
+ (No example for this operation).
2180
+
2181
+
2182
+ #### Using the put_sfvb_site_attributes_with_http_info variant
2183
+
2184
+ This returns an Array which contains the response data, status code and headers.
2185
+
2186
+ > <Array(<SfvbSiteAttributesResponse>, Integer, Hash)> put_sfvb_site_attributes_with_http_info(storefront_oid, site_attribute_update_request)
2187
+
2188
+ ```ruby
2189
+ begin
2190
+ # Change a storefront's site attributes
2191
+ data, status_code, headers = api_instance.put_sfvb_site_attributes_with_http_info(storefront_oid, site_attribute_update_request)
2192
+ p status_code # => 2xx
2193
+ p headers # => { ... }
2194
+ p data # => <SfvbSiteAttributesResponse>
2195
+ rescue UltracartClient::ApiError => e
2196
+ puts "Error when calling SfvbApi->put_sfvb_site_attributes_with_http_info: #{e}"
2197
+ end
2198
+ ```
2199
+
2200
+ ### Parameters
2201
+
2202
+ | Name | Type | Description | Notes |
2203
+ | ---- | ---- | ----------- | ----- |
2204
+ | **storefront_oid** | **Integer** | | |
2205
+ | **site_attribute_update_request** | [**SfvbSiteAttributeUpdateRequest**](SfvbSiteAttributeUpdateRequest.md) | Attributes to change | |
2206
+
2207
+ ### Return type
2208
+
2209
+ [**SfvbSiteAttributesResponse**](SfvbSiteAttributesResponse.md)
2210
+
2211
+ ### Authorization
2212
+
2213
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2214
+
2215
+ ### HTTP request headers
2216
+
2217
+ - **Content-Type**: application/json
2218
+ - **Accept**: application/json
2219
+
2220
+
2110
2221
  ## put_sfvb_theme_attributes
2111
2222
 
2112
2223
  > <SfvbThemeAttributesResponse> put_sfvb_theme_attributes(storefront_oid, theme_oid, attribute_update_request)
@@ -2277,7 +2388,7 @@ end
2277
2388
 
2278
2389
  Revert a container stored outside the file system
2279
2390
 
2280
- The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
2391
+ The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
2281
2392
 
2282
2393
 
2283
2394
  ### Examples
@@ -8,6 +8,7 @@
8
8
  | **container_name** | **String** | Container name. | [optional] |
9
9
  | **hash_sha256** | **String** | SHA-256 of the cjson. Send back as If-Match when writing. | [optional] |
10
10
  | **last_modified** | **String** | When the container was last modified, in the store&#39;s own record of it. Every owner type reports this. It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified. Two behaviours worth knowing. A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports. An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer. | [optional] |
11
+ | **merchant_item_id** | **String** | The merchant item id of the owning item, for item containers only and absent for every other owner type. owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached. It is read fresh on every call and so reflects a renamed item. A container&#39;s own id embeds this value, which is what a preview session keys an item container on. | [optional] |
11
12
  | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
12
13
  | **owner_type** | **String** | Where this container lives. | [optional] |
13
14
 
@@ -21,6 +22,7 @@ instance = UltracartClient::SfvbContainerResponse.new(
21
22
  container_name: null,
22
23
  hash_sha256: null,
23
24
  last_modified: null,
25
+ merchant_item_id: null,
24
26
  owner_object_id: null,
25
27
  owner_type: null
26
28
  )
@@ -0,0 +1,30 @@
1
+ # UltracartClient::SfvbSiteAttribute
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Attribute name, as a template&#39;s site attribute declaration spells it. Compare case insensitively. This is the value siteAttributeName refers to and the name $site.attr takes. | [optional] |
8
+ | **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 settings the StoreFronts General screen owns. | [optional] |
9
+ | **undeclared** | **Boolean** | True when no template declares this name and it is not a reserved setting. A template can still read it with $site.attr, so this is not proof it is unused, but a name you did not mean to create is most likely a misspelling. | [optional] |
10
+ | **used_by** | **String** | The other themes that declare this attribute, when the active theme does not. | [optional] |
11
+ | **used_by_current_theme** | **Boolean** | True when a template in the active theme declares this attribute. | [optional] |
12
+ | **value** | **String** | The stored value, or the template default when nothing has set it. | [optional] |
13
+ | **writable** | **Boolean** | True when this API will change the value. List, video list, mailing list and item set values are structured documents and must be edited in the store admin. Of the reserved settings only the title, the SEO description and keywords and the social account names are writable here. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ultracart_api'
19
+
20
+ instance = UltracartClient::SfvbSiteAttribute.new(
21
+ name: null,
22
+ type: null,
23
+ undeclared: null,
24
+ used_by: null,
25
+ used_by_current_theme: null,
26
+ value: null,
27
+ writable: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbSiteAttributeUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Attribute name. Matched without regard to case against what the storefront 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&#39;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::SfvbSiteAttributeUpdate.new(
17
+ name: null,
18
+ type: null,
19
+ value: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbSiteAttributeUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **attributes** | [**Array&lt;SfvbSiteAttributeUpdate&gt;**](SfvbSiteAttributeUpdate.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::SfvbSiteAttributeUpdateRequest.new(
15
+ attributes: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbSiteAttributesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **attributes** | [**Array&lt;SfvbSiteAttribute&gt;**](SfvbSiteAttribute.md) | Every site attribute, sorted by name. Credentials stored as site attributes are never included. | [optional] |
8
+ | **storefront_oid** | **Integer** | The storefront these attributes belong to. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbSiteAttributesResponse.new(
16
+ attributes: null,
17
+ storefront_oid: null
18
+ )
19
+ ```
20
+
@@ -673,7 +673,7 @@ module UltracartClient
673
673
  end
674
674
 
675
675
  # Read a container stored outside the file system
676
- # owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
676
+ # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
677
677
  # @param storefront_oid [Integer]
678
678
  # @param owner_type [String]
679
679
  # @param owner_object_id [String]
@@ -686,7 +686,7 @@ module UltracartClient
686
686
  end
687
687
 
688
688
  # Read a container stored outside the file system
689
- # owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
689
+ # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
690
690
  # @param storefront_oid [Integer]
691
691
  # @param owner_type [String]
692
692
  # @param owner_object_id [String]
@@ -752,7 +752,7 @@ module UltracartClient
752
752
  end
753
753
 
754
754
  # Read the CJSON stored in one container history entry
755
- # Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
755
+ # Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
756
756
  # @param storefront_oid [Integer]
757
757
  # @param container_history_oid [Integer]
758
758
  # @param [Hash] opts the optional parameters
@@ -766,7 +766,7 @@ module UltracartClient
766
766
  end
767
767
 
768
768
  # Read the CJSON stored in one container history entry
769
- # Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
769
+ # Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
770
770
  # @param storefront_oid [Integer]
771
771
  # @param container_history_oid [Integer]
772
772
  # @param [Hash] opts the optional parameters
@@ -1382,6 +1382,70 @@ module UltracartClient
1382
1382
  return data, status_code, headers
1383
1383
  end
1384
1384
 
1385
+ # Read a storefront's site attributes
1386
+ # The values the siteattribute element and $site.attr render. These are not in any file or theme. Attributes a template declares but nothing has set are included with the template's default, so the response describes what the templates can render rather than only what has been saved. Credentials stored as site attributes are never included.
1387
+ # @param storefront_oid [Integer]
1388
+ # @param [Hash] opts the optional parameters
1389
+ # @return [SfvbSiteAttributesResponse]
1390
+ def get_sfvb_site_attributes(storefront_oid, opts = {})
1391
+ data, _status_code, _headers = get_sfvb_site_attributes_with_http_info(storefront_oid, opts)
1392
+ data
1393
+ end
1394
+
1395
+ # Read a storefront&#39;s site attributes
1396
+ # The values the siteattribute element and $site.attr render. These are not in any file or theme. Attributes a template declares but nothing has set are included with the template&#39;s default, so the response describes what the templates can render rather than only what has been saved. Credentials stored as site attributes are never included.
1397
+ # @param storefront_oid [Integer]
1398
+ # @param [Hash] opts the optional parameters
1399
+ # @return [Array<(SfvbSiteAttributesResponse, Integer, Hash)>] SfvbSiteAttributesResponse data, response status code and response headers
1400
+ def get_sfvb_site_attributes_with_http_info(storefront_oid, opts = {})
1401
+ if @api_client.config.debugging
1402
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_site_attributes ...'
1403
+ end
1404
+ # verify the required parameter 'storefront_oid' is set
1405
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1406
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_site_attributes"
1407
+ end
1408
+ # resource path
1409
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/attributes'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
1410
+
1411
+ # query parameters
1412
+ query_params = opts[:query_params] || {}
1413
+
1414
+ # header parameters
1415
+ header_params = opts[:header_params] || {}
1416
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1417
+ # HTTP header 'Accept' (if needed)
1418
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1419
+
1420
+ # form parameters
1421
+ form_params = opts[:form_params] || {}
1422
+
1423
+ # http body (model)
1424
+ post_body = opts[:debug_body]
1425
+
1426
+ # return_type
1427
+ return_type = opts[:debug_return_type] || 'SfvbSiteAttributesResponse'
1428
+
1429
+ # auth_names
1430
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1431
+
1432
+ new_options = opts.merge(
1433
+ :operation => :"SfvbApi.get_sfvb_site_attributes",
1434
+ :header_params => header_params,
1435
+ :query_params => query_params,
1436
+ :form_params => form_params,
1437
+ :body => post_body,
1438
+ :auth_names => auth_names,
1439
+ :return_type => return_type
1440
+ )
1441
+
1442
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1443
+ if @api_client.config.debugging
1444
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_site_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1445
+ end
1446
+ return data, status_code, headers
1447
+ end
1448
+
1385
1449
  # Get a theme
1386
1450
  # @param storefront_oid [Integer]
1387
1451
  # @param theme_oid [Integer]
@@ -1777,6 +1841,7 @@ module UltracartClient
1777
1841
  end
1778
1842
 
1779
1843
  # Version history for a container stored outside the file system
1844
+ # Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
1780
1845
  # @param storefront_oid [Integer]
1781
1846
  # @param [Hash] opts the optional parameters
1782
1847
  # @option opts [String] :owner_type
@@ -1789,6 +1854,7 @@ module UltracartClient
1789
1854
  end
1790
1855
 
1791
1856
  # Version history for a container stored outside the file system
1857
+ # Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
1792
1858
  # @param storefront_oid [Integer]
1793
1859
  # @param [Hash] opts the optional parameters
1794
1860
  # @option opts [String] :owner_type
@@ -2233,7 +2299,7 @@ module UltracartClient
2233
2299
  end
2234
2300
 
2235
2301
  # Write a container stored outside the file system
2236
- # Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
2302
+ # Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
2237
2303
  # @param storefront_oid [Integer]
2238
2304
  # @param owner_type [String]
2239
2305
  # @param owner_object_id [String]
@@ -2248,7 +2314,7 @@ module UltracartClient
2248
2314
  end
2249
2315
 
2250
2316
  # Write a container stored outside the file system
2251
- # Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
2317
+ # Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
2252
2318
  # @param storefront_oid [Integer]
2253
2319
  # @param owner_type [String]
2254
2320
  # @param owner_object_id [String]
@@ -2746,6 +2812,81 @@ module UltracartClient
2746
2812
  return data, status_code, headers
2747
2813
  end
2748
2814
 
2815
+ # Change a storefront's site attributes
2816
+ # A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names. Credentials are refused. Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead. The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
2817
+ # @param storefront_oid [Integer]
2818
+ # @param site_attribute_update_request [SfvbSiteAttributeUpdateRequest] Attributes to change
2819
+ # @param [Hash] opts the optional parameters
2820
+ # @return [SfvbSiteAttributesResponse]
2821
+ def put_sfvb_site_attributes(storefront_oid, site_attribute_update_request, opts = {})
2822
+ data, _status_code, _headers = put_sfvb_site_attributes_with_http_info(storefront_oid, site_attribute_update_request, opts)
2823
+ data
2824
+ end
2825
+
2826
+ # Change a storefront&#39;s site attributes
2827
+ # A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names. Credentials are refused. Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead. The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
2828
+ # @param storefront_oid [Integer]
2829
+ # @param site_attribute_update_request [SfvbSiteAttributeUpdateRequest] Attributes to change
2830
+ # @param [Hash] opts the optional parameters
2831
+ # @return [Array<(SfvbSiteAttributesResponse, Integer, Hash)>] SfvbSiteAttributesResponse data, response status code and response headers
2832
+ def put_sfvb_site_attributes_with_http_info(storefront_oid, site_attribute_update_request, opts = {})
2833
+ if @api_client.config.debugging
2834
+ @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_site_attributes ...'
2835
+ end
2836
+ # verify the required parameter 'storefront_oid' is set
2837
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2838
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_site_attributes"
2839
+ end
2840
+ # verify the required parameter 'site_attribute_update_request' is set
2841
+ if @api_client.config.client_side_validation && site_attribute_update_request.nil?
2842
+ fail ArgumentError, "Missing the required parameter 'site_attribute_update_request' when calling SfvbApi.put_sfvb_site_attributes"
2843
+ end
2844
+ # resource path
2845
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/attributes'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
2846
+
2847
+ # query parameters
2848
+ query_params = opts[:query_params] || {}
2849
+
2850
+ # header parameters
2851
+ header_params = opts[:header_params] || {}
2852
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2853
+ # HTTP header 'Accept' (if needed)
2854
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2855
+ # HTTP header 'Content-Type'
2856
+ content_type = @api_client.select_header_content_type(['application/json'])
2857
+ if !content_type.nil?
2858
+ header_params['Content-Type'] = content_type
2859
+ end
2860
+
2861
+ # form parameters
2862
+ form_params = opts[:form_params] || {}
2863
+
2864
+ # http body (model)
2865
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(site_attribute_update_request)
2866
+
2867
+ # return_type
2868
+ return_type = opts[:debug_return_type] || 'SfvbSiteAttributesResponse'
2869
+
2870
+ # auth_names
2871
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2872
+
2873
+ new_options = opts.merge(
2874
+ :operation => :"SfvbApi.put_sfvb_site_attributes",
2875
+ :header_params => header_params,
2876
+ :query_params => query_params,
2877
+ :form_params => form_params,
2878
+ :body => post_body,
2879
+ :auth_names => auth_names,
2880
+ :return_type => return_type
2881
+ )
2882
+
2883
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2884
+ if @api_client.config.debugging
2885
+ @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_site_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2886
+ end
2887
+ return data, status_code, headers
2888
+ end
2889
+
2749
2890
  # Change a theme's colors, fonts and settings
2750
2891
  # A partial update. Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color. Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change. Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once. On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
2751
2892
  # @param storefront_oid [Integer]
@@ -2976,7 +3117,7 @@ module UltracartClient
2976
3117
  end
2977
3118
 
2978
3119
  # Revert a container stored outside the file system
2979
- # The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
3120
+ # The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
2980
3121
  # @param storefront_oid [Integer]
2981
3122
  # @param owner_type [String]
2982
3123
  # @param owner_object_id [String]
@@ -2991,7 +3132,7 @@ module UltracartClient
2991
3132
  end
2992
3133
 
2993
3134
  # Revert a container stored outside the file system
2994
- # The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
3135
+ # The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
2995
3136
  # @param storefront_oid [Integer]
2996
3137
  # @param owner_type [String]
2997
3138
  # @param owner_object_id [String]