ultracart_api 4.1.242 → 4.1.243
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 +3 -2
- data/docs/SfvbApi.md +1 -1
- data/docs/SfvbPageResponse.md +14 -0
- data/lib/ultracart_api/api/sfvb_api.rb +2 -2
- data/lib/ultracart_api/models/sfvb_page_response.rb +71 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5b11b83a656311382177e6356ccddbddd6a7f98e3deef76b4d03a96d8060ea38
|
|
4
|
+
data.tar.gz: 250b9777c8799bdbe2fa174aac456e3735ef4038196741c8bddee54298e739a2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e3c62d6332f14096d26293deb7fe2eab025c0fb7b74e4e8e83d3519a7ef7933962b36a89e0acc76102258eed56900c0995aa8ec38ae59b5ff382319651343f79
|
|
7
|
+
data.tar.gz: 58e4998078833f999ded5c211dacf30741c73e4c419ee8dfa8e7abfa3b26f7c2078d28c6aed608d4182bd9a9dfc42cb54b5fb974efe5f4064f13e7e4d5068520
|
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.243
|
|
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.243'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -2583,6 +2583,7 @@ Not every change is committed to every SDK.
|
|
|
2583
2583
|
|
|
2584
2584
|
| Version | Date | Comments |
|
|
2585
2585
|
| --: | :-: | --- |
|
|
2586
|
+
| 4.1.243 | 11/11/2026 | sfvb internal testing |
|
|
2586
2587
|
| 4.1.242 | 11/11/2026 | sfvb internal testing |
|
|
2587
2588
|
| 4.1.241 | 11/10/2026 | sfvb internal testing |
|
|
2588
2589
|
| 4.1.240 | 11/10/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -8569,7 +8569,7 @@ end
|
|
|
8569
8569
|
|
|
8570
8570
|
Check what upgrading a theme would do
|
|
8571
8571
|
|
|
8572
|
-
The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
8572
|
+
The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
8573
8573
|
|
|
8574
8574
|
|
|
8575
8575
|
### Examples
|
data/docs/SfvbPageResponse.md
CHANGED
|
@@ -5,12 +5,19 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
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
|
+
| **blog_post_template** | **String** | Template that renders the blog posts under this page. Omitted when not set. | [optional] |
|
|
8
9
|
| **description** | **String** | The page description, the text a page template renders as the page's description. Omitted when empty. | [optional] |
|
|
9
10
|
| **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
|
|
10
11
|
| **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
|
|
11
12
|
| **item_template** | **String** | Template file that renders the item pages under this page. | [optional] |
|
|
13
|
+
| **items_per_page** | **Integer** | Items per page on a template that paginates. Omitted when the template's default applies. | [optional] |
|
|
12
14
|
| **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] |
|
|
15
|
+
| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
|
|
13
16
|
| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
|
|
17
|
+
| **review_template** | **String** | Template that renders the item review pages under this page. Omitted when not set. | [optional] |
|
|
18
|
+
| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set. | [optional] |
|
|
19
|
+
| **sort_order_child_groups** | **String** | How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom. | [optional] |
|
|
20
|
+
| **sort_order_child_items** | **String** | How the page's items are ordered. IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom. | [optional] |
|
|
14
21
|
| **title** | **String** | The page title. | [optional] |
|
|
15
22
|
| **visible** | **Boolean** | False when the page is hidden. A hidden page answers 404 to shoppers. | [optional] |
|
|
16
23
|
| **visible_dts** | **String** | When set, the page stays hidden until this time (ISO 8601, UTC). | [optional] |
|
|
@@ -22,12 +29,19 @@ require 'ultracart_api'
|
|
|
22
29
|
|
|
23
30
|
instance = UltracartClient::SfvbPageResponse.new(
|
|
24
31
|
attributes: null,
|
|
32
|
+
blog_post_template: null,
|
|
25
33
|
description: null,
|
|
26
34
|
exclude_from_sitemap: null,
|
|
27
35
|
group_template: null,
|
|
28
36
|
item_template: null,
|
|
37
|
+
items_per_page: null,
|
|
29
38
|
multimedia: null,
|
|
39
|
+
page_type: null,
|
|
30
40
|
path: null,
|
|
41
|
+
review_template: null,
|
|
42
|
+
sort_order: null,
|
|
43
|
+
sort_order_child_groups: null,
|
|
44
|
+
sort_order_child_items: null,
|
|
31
45
|
title: null,
|
|
32
46
|
visible: null,
|
|
33
47
|
visible_dts: null
|
|
@@ -10872,7 +10872,7 @@ module UltracartClient
|
|
|
10872
10872
|
end
|
|
10873
10873
|
|
|
10874
10874
|
# Check what upgrading a theme would do
|
|
10875
|
-
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
10875
|
+
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
10876
10876
|
# @param storefront_oid [Integer]
|
|
10877
10877
|
# @param theme_oid [Integer]
|
|
10878
10878
|
# @param [Hash] opts the optional parameters
|
|
@@ -10884,7 +10884,7 @@ module UltracartClient
|
|
|
10884
10884
|
end
|
|
10885
10885
|
|
|
10886
10886
|
# Check what upgrading a theme would do
|
|
10887
|
-
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
10887
|
+
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
10888
10888
|
# @param storefront_oid [Integer]
|
|
10889
10889
|
# @param theme_oid [Integer]
|
|
10890
10890
|
# @param [Hash] opts the optional parameters
|
|
@@ -18,6 +18,9 @@ module UltracartClient
|
|
|
18
18
|
# 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.
|
|
19
19
|
attr_accessor :attributes
|
|
20
20
|
|
|
21
|
+
# Template that renders the blog posts under this page. Omitted when not set.
|
|
22
|
+
attr_accessor :blog_post_template
|
|
23
|
+
|
|
21
24
|
# The page description, the text a page template renders as the page's description. Omitted when empty.
|
|
22
25
|
attr_accessor :description
|
|
23
26
|
|
|
@@ -30,12 +33,30 @@ module UltracartClient
|
|
|
30
33
|
# Template file that renders the item pages under this page.
|
|
31
34
|
attr_accessor :item_template
|
|
32
35
|
|
|
36
|
+
# Items per page on a template that paginates. Omitted when the template's default applies.
|
|
37
|
+
attr_accessor :items_per_page
|
|
38
|
+
|
|
33
39
|
# 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.
|
|
34
40
|
attr_accessor :multimedia
|
|
35
41
|
|
|
42
|
+
# S for a static page, D for a dynamic one.
|
|
43
|
+
attr_accessor :page_type
|
|
44
|
+
|
|
36
45
|
# The page path, normalized to begin and end with a slash.
|
|
37
46
|
attr_accessor :path
|
|
38
47
|
|
|
48
|
+
# Template that renders the item review pages under this page. Omitted when not set.
|
|
49
|
+
attr_accessor :review_template
|
|
50
|
+
|
|
51
|
+
# Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set.
|
|
52
|
+
attr_accessor :sort_order
|
|
53
|
+
|
|
54
|
+
# How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom.
|
|
55
|
+
attr_accessor :sort_order_child_groups
|
|
56
|
+
|
|
57
|
+
# How the page's items are ordered. IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom.
|
|
58
|
+
attr_accessor :sort_order_child_items
|
|
59
|
+
|
|
39
60
|
# The page title.
|
|
40
61
|
attr_accessor :title
|
|
41
62
|
|
|
@@ -49,12 +70,19 @@ module UltracartClient
|
|
|
49
70
|
def self.attribute_map
|
|
50
71
|
{
|
|
51
72
|
:'attributes' => :'attributes',
|
|
73
|
+
:'blog_post_template' => :'blog_post_template',
|
|
52
74
|
:'description' => :'description',
|
|
53
75
|
:'exclude_from_sitemap' => :'exclude_from_sitemap',
|
|
54
76
|
:'group_template' => :'group_template',
|
|
55
77
|
:'item_template' => :'item_template',
|
|
78
|
+
:'items_per_page' => :'items_per_page',
|
|
56
79
|
:'multimedia' => :'multimedia',
|
|
80
|
+
:'page_type' => :'page_type',
|
|
57
81
|
:'path' => :'path',
|
|
82
|
+
:'review_template' => :'review_template',
|
|
83
|
+
:'sort_order' => :'sort_order',
|
|
84
|
+
:'sort_order_child_groups' => :'sort_order_child_groups',
|
|
85
|
+
:'sort_order_child_items' => :'sort_order_child_items',
|
|
58
86
|
:'title' => :'title',
|
|
59
87
|
:'visible' => :'visible',
|
|
60
88
|
:'visible_dts' => :'visible_dts'
|
|
@@ -70,12 +98,19 @@ module UltracartClient
|
|
|
70
98
|
def self.openapi_types
|
|
71
99
|
{
|
|
72
100
|
:'attributes' => :'Array<SfvbPageAttribute>',
|
|
101
|
+
:'blog_post_template' => :'String',
|
|
73
102
|
:'description' => :'String',
|
|
74
103
|
:'exclude_from_sitemap' => :'Boolean',
|
|
75
104
|
:'group_template' => :'String',
|
|
76
105
|
:'item_template' => :'String',
|
|
106
|
+
:'items_per_page' => :'Integer',
|
|
77
107
|
:'multimedia' => :'Array<SfvbPageMultimedia>',
|
|
108
|
+
:'page_type' => :'String',
|
|
78
109
|
:'path' => :'String',
|
|
110
|
+
:'review_template' => :'String',
|
|
111
|
+
:'sort_order' => :'Integer',
|
|
112
|
+
:'sort_order_child_groups' => :'String',
|
|
113
|
+
:'sort_order_child_items' => :'String',
|
|
79
114
|
:'title' => :'String',
|
|
80
115
|
:'visible' => :'Boolean',
|
|
81
116
|
:'visible_dts' => :'String'
|
|
@@ -109,6 +144,10 @@ module UltracartClient
|
|
|
109
144
|
end
|
|
110
145
|
end
|
|
111
146
|
|
|
147
|
+
if attributes.key?(:'blog_post_template')
|
|
148
|
+
self.blog_post_template = attributes[:'blog_post_template']
|
|
149
|
+
end
|
|
150
|
+
|
|
112
151
|
if attributes.key?(:'description')
|
|
113
152
|
self.description = attributes[:'description']
|
|
114
153
|
end
|
|
@@ -125,16 +164,40 @@ module UltracartClient
|
|
|
125
164
|
self.item_template = attributes[:'item_template']
|
|
126
165
|
end
|
|
127
166
|
|
|
167
|
+
if attributes.key?(:'items_per_page')
|
|
168
|
+
self.items_per_page = attributes[:'items_per_page']
|
|
169
|
+
end
|
|
170
|
+
|
|
128
171
|
if attributes.key?(:'multimedia')
|
|
129
172
|
if (value = attributes[:'multimedia']).is_a?(Array)
|
|
130
173
|
self.multimedia = value
|
|
131
174
|
end
|
|
132
175
|
end
|
|
133
176
|
|
|
177
|
+
if attributes.key?(:'page_type')
|
|
178
|
+
self.page_type = attributes[:'page_type']
|
|
179
|
+
end
|
|
180
|
+
|
|
134
181
|
if attributes.key?(:'path')
|
|
135
182
|
self.path = attributes[:'path']
|
|
136
183
|
end
|
|
137
184
|
|
|
185
|
+
if attributes.key?(:'review_template')
|
|
186
|
+
self.review_template = attributes[:'review_template']
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
if attributes.key?(:'sort_order')
|
|
190
|
+
self.sort_order = attributes[:'sort_order']
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
if attributes.key?(:'sort_order_child_groups')
|
|
194
|
+
self.sort_order_child_groups = attributes[:'sort_order_child_groups']
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
if attributes.key?(:'sort_order_child_items')
|
|
198
|
+
self.sort_order_child_items = attributes[:'sort_order_child_items']
|
|
199
|
+
end
|
|
200
|
+
|
|
138
201
|
if attributes.key?(:'title')
|
|
139
202
|
self.title = attributes[:'title']
|
|
140
203
|
end
|
|
@@ -167,12 +230,19 @@ module UltracartClient
|
|
|
167
230
|
return true if self.equal?(o)
|
|
168
231
|
self.class == o.class &&
|
|
169
232
|
attributes == o.attributes &&
|
|
233
|
+
blog_post_template == o.blog_post_template &&
|
|
170
234
|
description == o.description &&
|
|
171
235
|
exclude_from_sitemap == o.exclude_from_sitemap &&
|
|
172
236
|
group_template == o.group_template &&
|
|
173
237
|
item_template == o.item_template &&
|
|
238
|
+
items_per_page == o.items_per_page &&
|
|
174
239
|
multimedia == o.multimedia &&
|
|
240
|
+
page_type == o.page_type &&
|
|
175
241
|
path == o.path &&
|
|
242
|
+
review_template == o.review_template &&
|
|
243
|
+
sort_order == o.sort_order &&
|
|
244
|
+
sort_order_child_groups == o.sort_order_child_groups &&
|
|
245
|
+
sort_order_child_items == o.sort_order_child_items &&
|
|
176
246
|
title == o.title &&
|
|
177
247
|
visible == o.visible &&
|
|
178
248
|
visible_dts == o.visible_dts
|
|
@@ -187,7 +257,7 @@ module UltracartClient
|
|
|
187
257
|
# Calculates hash code according to all attributes.
|
|
188
258
|
# @return [Integer] Hash code
|
|
189
259
|
def hash
|
|
190
|
-
[attributes, description, exclude_from_sitemap, group_template, item_template, multimedia, path, title, visible, visible_dts].hash
|
|
260
|
+
[attributes, blog_post_template, description, exclude_from_sitemap, group_template, item_template, items_per_page, multimedia, page_type, path, review_template, sort_order, sort_order_child_groups, sort_order_child_items, title, visible, visible_dts].hash
|
|
191
261
|
end
|
|
192
262
|
|
|
193
263
|
# Builds the object from hash
|