ultracart_api 4.1.145 → 4.1.147

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: 7f1235fdf756a9c04d861c9fd8359c00b55a7c1f54d77928a4f1b27f9ca59039
4
- data.tar.gz: 831f4dac9980275b50aa94608545629d32d6987e1033ba9a3e89204fec4192b6
3
+ metadata.gz: 490ac8086f81d0ada26de478aa8456404659ba28b4589f778117e1aeab05d043
4
+ data.tar.gz: c3df95b939b310dbd25c9b24e02c2004c2a540787506fb01f49c4b2413c08b37
5
5
  SHA512:
6
- metadata.gz: fe9e072122730406bbbcbc219ff801730856aca407f8e6635a9e1632db873f4cb9ee884bea4d95626aba678ef4e13bef4e9a21cd1e7587a81accd18864a22e48
7
- data.tar.gz: c77353896854a354eb94be2bbf5562c61a3156eca719855080f45e5cdd70e1ec608dbb439c79a02467ffd4bbd956e3b99df05b50f3d5c3613f8164c7eb4c7215
6
+ metadata.gz: 4115a13993932d0c78cc857bc053e96586797d97dc8b7a22e860f889ea0f33acd854f07d6c08994bf0b37b8c3f47d2852348bb684fd67ef427222538d6a2547b
7
+ data.tar.gz: a7022fa9cf5acd43820c5383d55559046f586440d728b496da373d4c508f9f626a1e689084c1935b405014dbee3306eee752c7d2ac66d89cbbe99797287ef5b4
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.145
10
+ - Package version: 4.1.147
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.145'
19
+ gem 'ultracart_api', '4.1.147'
20
20
  ```
21
21
 
22
22
  install:
@@ -1927,6 +1927,8 @@ Not every change is committed to every SDK.
1927
1927
 
1928
1928
  | Version | Date | Comments |
1929
1929
  | --: | :-: | --- |
1930
+ | 4.1.147 | 09/04/2026 | sfvb - internal testing |
1931
+ | 4.1.146 | 09/03/2026 | sfvb - internal testing |
1930
1932
  | 4.1.145 | 09/02/2026 | sfvb - internal testing |
1931
1933
  | 4.1.144 | 09/02/2026 | sfvb - internal testing |
1932
1934
  | 4.1.143 | 09/02/2026 | sfvb - internal development |
data/docs/SfvbApi.md CHANGED
@@ -103,7 +103,7 @@ end
103
103
 
104
104
  Create a preview session
105
105
 
106
- Returns a server generated session id to push containers into. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
106
+ Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
107
107
 
108
108
 
109
109
  ### Examples
@@ -1554,7 +1554,7 @@ end
1554
1554
 
1555
1555
  Push containers into a preview session
1556
1556
 
1557
- Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
1557
+ Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
1558
1558
 
1559
1559
 
1560
1560
  ### Examples
@@ -4,16 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **active_theme** | **Boolean** | True when this container lives in the theme currently serving live traffic. Writing to it requires the sfvb_publish scope. | [optional] |
8
7
  | **cjson** | **String** | The container JSON. Runtime state is stripped on the way out. | [optional] |
9
- | **container_id** | **String** | Container id as the compiler will derive it. | [optional] |
10
8
  | **container_name** | **String** | Container name. | [optional] |
11
9
  | **hash_sha256** | **String** | SHA-256 of the cjson. Send back as If-Match when writing. | [optional] |
12
- | **last_modified** | **String** | When the container was last modified, where the store records it. | [optional] |
10
+ | **last_modified** | **String** | When the container was last modified, in the store'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] |
13
11
  | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
14
12
  | **owner_type** | **String** | Where this container lives. | [optional] |
15
- | **path** | **String** | File path, for theme and page containers only. | [optional] |
16
- | **version** | **Integer** | File version, for theme and page containers only. | [optional] |
17
13
 
18
14
  ## Example
19
15
 
@@ -21,16 +17,12 @@
21
17
  require 'ultracart_api'
22
18
 
23
19
  instance = UltracartClient::SfvbContainerResponse.new(
24
- active_theme: null,
25
20
  cjson: null,
26
- container_id: null,
27
21
  container_name: null,
28
22
  hash_sha256: null,
29
23
  last_modified: null,
30
24
  owner_object_id: null,
31
- owner_type: null,
32
- path: null,
33
- version: null
25
+ owner_type: null
34
26
  )
35
27
  ```
36
28
 
@@ -7,10 +7,10 @@
7
7
  | **comment** | **String** | Comment recorded with the write. | [optional] |
8
8
  | **current** | **Boolean** | True for the version currently on disk. | [optional] |
9
9
  | **edited_by** | **String** | Login of whoever wrote this version. | [optional] |
10
- | **fs_file_history_oid** | **Integer** | History record oid. | [optional] |
10
+ | **fs_file_history_oid** | **Integer** | History record oid, for correlating an entry with the file manager. Absent on the entry marked current, which is the content on disk right now and has no history row of its own. Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it. Fetch and revert a file version by path plus version instead. | [optional] |
11
11
  | **hash_sha256** | **String** | SHA-256 of this version's content. | [optional] |
12
12
  | **last_modified** | **String** | When this version was written. | [optional] |
13
- | **revertable** | **Boolean** | True when this version can be reverted to. | [optional] |
13
+ | **revertable** | **Boolean** | True when this version can be reverted to, which is every entry except the one marked current. Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false. Test whether the key is present, or simpler still, use current. | [optional] |
14
14
  | **size** | **Integer** | Size in bytes. | [optional] |
15
15
  | **version** | **Integer** | Version number. Pass to files/content or files/revert. | [optional] |
16
16
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **folder** | **String** | Directory name for the new theme under /themes/. Letters and numbers; it is cleansed before use. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
7
+ | **folder** | **String** | Directory name for the new theme under /themes/. Letters and numbers, one path segment. Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
8
8
  | **target_storefront_oid** | **Integer** | Storefront to create the copy on. Defaults to the storefront in the path. Supply it only when copying a theme between storefronts you own. | [optional] |
9
9
  | **theme_name** | **String** | Name for the new theme. | [optional] |
10
10
 
@@ -15,7 +15,7 @@
15
15
  | **status** | **String** | Raw job status. | [optional] |
16
16
  | **submitted_dts** | **String** | When the job was queued. | [optional] |
17
17
  | **success** | **Boolean** | True only when the job finished successfully. Check complete first. | [optional] |
18
- | **target_path** | **String** | Path the new theme was created at. Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result. Once the job completes, list themes and match on this path. | [optional] |
18
+ | **target_path** | **String** | Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. The theme oid itself is NOT returned, so once the job completes you list themes and match on this path. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending. | [optional] |
19
19
 
20
20
  ## Example
21
21
 
@@ -7,10 +7,16 @@
7
7
  | **container_manager_version** | **String** | Container manager version used to compile for this merchant. | [optional] |
8
8
  | **container_versions_retained** | **Integer** | Versions kept per non-file container before the oldest are pruned. Beyond this, history is gone - not merely paginated. | [optional] |
9
9
  | **element_count** | **Integer** | Number of element types this version recognizes. | [optional] |
10
+ | **max_asset_bytes** | **Integer** | Largest binary asset that can be uploaded, in bytes, for every accepted type except video. | [optional] |
10
11
  | **max_cjson_bytes** | **Integer** | Largest CJSON document that will be parsed, in bytes. | [optional] |
12
+ | **max_directory_entries** | **Integer** | Most entries one directory listing returns. Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for. The listing does set a truncated flag when it drops entries. | [optional] |
13
+ | **max_library_results_per_page** | **Integer** | Most element library results one page returns. Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut. | [optional] |
11
14
  | **max_preview_session_bytes** | **Integer** | Largest payload one preview session may hold, in bytes. | [optional] |
15
+ | **max_revertable_bytes** | **Integer** | Largest historical version files/revert will restore, in bytes. Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to. | [optional] |
12
16
  | **max_search_results** | **Integer** | Hard ceiling on file search results per page. | [optional] |
13
- | **max_template_bytes** | **Integer** | Largest template file that can be written, in bytes. | [optional] |
17
+ | **max_template_bytes** | **Integer** | Largest .vm template that can be written, in bytes. Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back. Use max_text_read_bytes for that. | [optional] |
18
+ | **max_text_read_bytes** | **Integer** | Largest file files/content will return as text, in bytes. A file above this is refused with sfvb.too_large however small its history versions are. Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template. Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling. | [optional] |
19
+ | **max_video_bytes** | **Integer** | Largest video that can be uploaded, in bytes. Video is the one type allowed past max_asset_bytes. | [optional] |
14
20
  | **max_widget_ids_per_request** | **Integer** | Most widget ids that can be reserved in one call. | [optional] |
15
21
  | **preview_session_ttl_seconds** | **Integer** | Seconds a preview session survives before expiring. | [optional] |
16
22
  | **release** | **String** | Release channel selected for this merchant. | [optional] |
@@ -24,10 +30,16 @@ instance = UltracartClient::SfvbVersionResponse.new(
24
30
  container_manager_version: null,
25
31
  container_versions_retained: null,
26
32
  element_count: null,
33
+ max_asset_bytes: null,
27
34
  max_cjson_bytes: null,
35
+ max_directory_entries: null,
36
+ max_library_results_per_page: null,
28
37
  max_preview_session_bytes: null,
38
+ max_revertable_bytes: null,
29
39
  max_search_results: null,
30
40
  max_template_bytes: null,
41
+ max_text_read_bytes: null,
42
+ max_video_bytes: null,
31
43
  max_widget_ids_per_request: null,
32
44
  preview_session_ttl_seconds: null,
33
45
  release: null
@@ -102,7 +102,7 @@ module UltracartClient
102
102
  end
103
103
 
104
104
  # Create a preview session
105
- # Returns a server generated session id to push containers into. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
105
+ # Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
106
106
  # @param storefront_oid [Integer]
107
107
  # @param [Hash] opts the optional parameters
108
108
  # @return [SfvbPreviewSessionResponse]
@@ -112,7 +112,7 @@ module UltracartClient
112
112
  end
113
113
 
114
114
  # Create a preview session
115
- # Returns a server generated session id to push containers into. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
115
+ # Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random. The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API. Expires after eight hours and can be deleted sooner. Requires a token that resolves to a user, so use the device authorization flow.
116
116
  # @param storefront_oid [Integer]
117
117
  # @param [Hash] opts the optional parameters
118
118
  # @return [Array<(SfvbPreviewSessionResponse, Integer, Hash)>] SfvbPreviewSessionResponse data, response status code and response headers
@@ -1990,7 +1990,7 @@ module UltracartClient
1990
1990
  end
1991
1991
 
1992
1992
  # Push containers into a preview session
1993
- # Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
1993
+ # Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
1994
1994
  # @param storefront_oid [Integer]
1995
1995
  # @param preview_session_id [String]
1996
1996
  # @param preview_session [SfvbPreviewSessionRequest] Containers to stage in the preview session
@@ -2003,7 +2003,7 @@ module UltracartClient
2003
2003
  end
2004
2004
 
2005
2005
  # Push containers into a preview session
2006
- # Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
2006
+ # Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
2007
2007
  # @param storefront_oid [Integer]
2008
2008
  # @param preview_session_id [String]
2009
2009
  # @param preview_session [SfvbPreviewSessionRequest] Containers to stage in the preview session
@@ -15,22 +15,16 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class SfvbContainerResponse
18
- # True when this container lives in the theme currently serving live traffic. Writing to it requires the sfvb_publish scope.
19
- attr_accessor :active_theme
20
-
21
18
  # The container JSON. Runtime state is stripped on the way out.
22
19
  attr_accessor :cjson
23
20
 
24
- # Container id as the compiler will derive it.
25
- attr_accessor :container_id
26
-
27
21
  # Container name.
28
22
  attr_accessor :container_name
29
23
 
30
24
  # SHA-256 of the cjson. Send back as If-Match when writing.
31
25
  attr_accessor :hash_sha256
32
26
 
33
- # When the container was last modified, where the store records it.
27
+ # When the container was last modified, in the store'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.
34
28
  attr_accessor :last_modified
35
29
 
36
30
  # Identifier of the owning object within its store.
@@ -39,12 +33,6 @@ module UltracartClient
39
33
  # Where this container lives.
40
34
  attr_accessor :owner_type
41
35
 
42
- # File path, for theme and page containers only.
43
- attr_accessor :path
44
-
45
- # File version, for theme and page containers only.
46
- attr_accessor :version
47
-
48
36
  class EnumAttributeValidator
49
37
  attr_reader :datatype
50
38
  attr_reader :allowable_values
@@ -70,16 +58,12 @@ module UltracartClient
70
58
  # Attribute mapping from ruby-style variable name to JSON key.
71
59
  def self.attribute_map
72
60
  {
73
- :'active_theme' => :'active_theme',
74
61
  :'cjson' => :'cjson',
75
- :'container_id' => :'container_id',
76
62
  :'container_name' => :'container_name',
77
63
  :'hash_sha256' => :'hash_sha256',
78
64
  :'last_modified' => :'last_modified',
79
65
  :'owner_object_id' => :'owner_object_id',
80
- :'owner_type' => :'owner_type',
81
- :'path' => :'path',
82
- :'version' => :'version'
66
+ :'owner_type' => :'owner_type'
83
67
  }
84
68
  end
85
69
 
@@ -91,16 +75,12 @@ module UltracartClient
91
75
  # Attribute type mapping.
92
76
  def self.openapi_types
93
77
  {
94
- :'active_theme' => :'Boolean',
95
78
  :'cjson' => :'String',
96
- :'container_id' => :'String',
97
79
  :'container_name' => :'String',
98
80
  :'hash_sha256' => :'String',
99
81
  :'last_modified' => :'String',
100
82
  :'owner_object_id' => :'String',
101
- :'owner_type' => :'String',
102
- :'path' => :'String',
103
- :'version' => :'Integer'
83
+ :'owner_type' => :'String'
104
84
  }
105
85
  end
106
86
 
@@ -125,18 +105,10 @@ module UltracartClient
125
105
  h[k.to_sym] = v
126
106
  }
127
107
 
128
- if attributes.key?(:'active_theme')
129
- self.active_theme = attributes[:'active_theme']
130
- end
131
-
132
108
  if attributes.key?(:'cjson')
133
109
  self.cjson = attributes[:'cjson']
134
110
  end
135
111
 
136
- if attributes.key?(:'container_id')
137
- self.container_id = attributes[:'container_id']
138
- end
139
-
140
112
  if attributes.key?(:'container_name')
141
113
  self.container_name = attributes[:'container_name']
142
114
  end
@@ -156,14 +128,6 @@ module UltracartClient
156
128
  if attributes.key?(:'owner_type')
157
129
  self.owner_type = attributes[:'owner_type']
158
130
  end
159
-
160
- if attributes.key?(:'path')
161
- self.path = attributes[:'path']
162
- end
163
-
164
- if attributes.key?(:'version')
165
- self.version = attributes[:'version']
166
- end
167
131
  end
168
132
 
169
133
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -196,16 +160,12 @@ module UltracartClient
196
160
  def ==(o)
197
161
  return true if self.equal?(o)
198
162
  self.class == o.class &&
199
- active_theme == o.active_theme &&
200
163
  cjson == o.cjson &&
201
- container_id == o.container_id &&
202
164
  container_name == o.container_name &&
203
165
  hash_sha256 == o.hash_sha256 &&
204
166
  last_modified == o.last_modified &&
205
167
  owner_object_id == o.owner_object_id &&
206
- owner_type == o.owner_type &&
207
- path == o.path &&
208
- version == o.version
168
+ owner_type == o.owner_type
209
169
  end
210
170
 
211
171
  # @see the `==` method
@@ -217,7 +177,7 @@ module UltracartClient
217
177
  # Calculates hash code according to all attributes.
218
178
  # @return [Integer] Hash code
219
179
  def hash
220
- [active_theme, cjson, container_id, container_name, hash_sha256, last_modified, owner_object_id, owner_type, path, version].hash
180
+ [cjson, container_name, hash_sha256, last_modified, owner_object_id, owner_type].hash
221
181
  end
222
182
 
223
183
  # Builds the object from hash
@@ -24,7 +24,7 @@ module UltracartClient
24
24
  # Login of whoever wrote this version.
25
25
  attr_accessor :edited_by
26
26
 
27
- # History record oid.
27
+ # History record oid, for correlating an entry with the file manager. Absent on the entry marked current, which is the content on disk right now and has no history row of its own. Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it. Fetch and revert a file version by path plus version instead.
28
28
  attr_accessor :fs_file_history_oid
29
29
 
30
30
  # SHA-256 of this version's content.
@@ -33,7 +33,7 @@ module UltracartClient
33
33
  # When this version was written.
34
34
  attr_accessor :last_modified
35
35
 
36
- # True when this version can be reverted to.
36
+ # True when this version can be reverted to, which is every entry except the one marked current. Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false. Test whether the key is present, or simpler still, use current.
37
37
  attr_accessor :revertable
38
38
 
39
39
  # Size in bytes.
@@ -15,7 +15,7 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class SfvbThemeDuplicateRequest
18
- # Directory name for the new theme under /themes/. Letters and numbers; it is cleansed before use. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
18
+ # Directory name for the new theme under /themes/. Letters and numbers, one path segment. Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
19
19
  attr_accessor :folder
20
20
 
21
21
  # Storefront to create the copy on. Defaults to the storefront in the path. Supply it only when copying a theme between storefronts you own.
@@ -48,7 +48,7 @@ module UltracartClient
48
48
  # True only when the job finished successfully. Check complete first.
49
49
  attr_accessor :success
50
50
 
51
- # Path the new theme was created at. Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result. Once the job completes, list themes and match on this path.
51
+ # Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. The theme oid itself is NOT returned, so once the job completes you list themes and match on this path. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending.
52
52
  attr_accessor :target_path
53
53
 
54
54
  class EnumAttributeValidator
@@ -24,18 +24,36 @@ module UltracartClient
24
24
  # Number of element types this version recognizes.
25
25
  attr_accessor :element_count
26
26
 
27
+ # Largest binary asset that can be uploaded, in bytes, for every accepted type except video.
28
+ attr_accessor :max_asset_bytes
29
+
27
30
  # Largest CJSON document that will be parsed, in bytes.
28
31
  attr_accessor :max_cjson_bytes
29
32
 
33
+ # Most entries one directory listing returns. Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for. The listing does set a truncated flag when it drops entries.
34
+ attr_accessor :max_directory_entries
35
+
36
+ # Most element library results one page returns. Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut.
37
+ attr_accessor :max_library_results_per_page
38
+
30
39
  # Largest payload one preview session may hold, in bytes.
31
40
  attr_accessor :max_preview_session_bytes
32
41
 
42
+ # Largest historical version files/revert will restore, in bytes. Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to.
43
+ attr_accessor :max_revertable_bytes
44
+
33
45
  # Hard ceiling on file search results per page.
34
46
  attr_accessor :max_search_results
35
47
 
36
- # Largest template file that can be written, in bytes.
48
+ # Largest .vm template that can be written, in bytes. Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back. Use max_text_read_bytes for that.
37
49
  attr_accessor :max_template_bytes
38
50
 
51
+ # Largest file files/content will return as text, in bytes. A file above this is refused with sfvb.too_large however small its history versions are. Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template. Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling.
52
+ attr_accessor :max_text_read_bytes
53
+
54
+ # Largest video that can be uploaded, in bytes. Video is the one type allowed past max_asset_bytes.
55
+ attr_accessor :max_video_bytes
56
+
39
57
  # Most widget ids that can be reserved in one call.
40
58
  attr_accessor :max_widget_ids_per_request
41
59
 
@@ -73,10 +91,16 @@ module UltracartClient
73
91
  :'container_manager_version' => :'container_manager_version',
74
92
  :'container_versions_retained' => :'container_versions_retained',
75
93
  :'element_count' => :'element_count',
94
+ :'max_asset_bytes' => :'max_asset_bytes',
76
95
  :'max_cjson_bytes' => :'max_cjson_bytes',
96
+ :'max_directory_entries' => :'max_directory_entries',
97
+ :'max_library_results_per_page' => :'max_library_results_per_page',
77
98
  :'max_preview_session_bytes' => :'max_preview_session_bytes',
99
+ :'max_revertable_bytes' => :'max_revertable_bytes',
78
100
  :'max_search_results' => :'max_search_results',
79
101
  :'max_template_bytes' => :'max_template_bytes',
102
+ :'max_text_read_bytes' => :'max_text_read_bytes',
103
+ :'max_video_bytes' => :'max_video_bytes',
80
104
  :'max_widget_ids_per_request' => :'max_widget_ids_per_request',
81
105
  :'preview_session_ttl_seconds' => :'preview_session_ttl_seconds',
82
106
  :'release' => :'release'
@@ -94,10 +118,16 @@ module UltracartClient
94
118
  :'container_manager_version' => :'String',
95
119
  :'container_versions_retained' => :'Integer',
96
120
  :'element_count' => :'Integer',
121
+ :'max_asset_bytes' => :'Integer',
97
122
  :'max_cjson_bytes' => :'Integer',
123
+ :'max_directory_entries' => :'Integer',
124
+ :'max_library_results_per_page' => :'Integer',
98
125
  :'max_preview_session_bytes' => :'Integer',
126
+ :'max_revertable_bytes' => :'Integer',
99
127
  :'max_search_results' => :'Integer',
100
128
  :'max_template_bytes' => :'Integer',
129
+ :'max_text_read_bytes' => :'Integer',
130
+ :'max_video_bytes' => :'Integer',
101
131
  :'max_widget_ids_per_request' => :'Integer',
102
132
  :'preview_session_ttl_seconds' => :'Integer',
103
133
  :'release' => :'String'
@@ -137,14 +167,30 @@ module UltracartClient
137
167
  self.element_count = attributes[:'element_count']
138
168
  end
139
169
 
170
+ if attributes.key?(:'max_asset_bytes')
171
+ self.max_asset_bytes = attributes[:'max_asset_bytes']
172
+ end
173
+
140
174
  if attributes.key?(:'max_cjson_bytes')
141
175
  self.max_cjson_bytes = attributes[:'max_cjson_bytes']
142
176
  end
143
177
 
178
+ if attributes.key?(:'max_directory_entries')
179
+ self.max_directory_entries = attributes[:'max_directory_entries']
180
+ end
181
+
182
+ if attributes.key?(:'max_library_results_per_page')
183
+ self.max_library_results_per_page = attributes[:'max_library_results_per_page']
184
+ end
185
+
144
186
  if attributes.key?(:'max_preview_session_bytes')
145
187
  self.max_preview_session_bytes = attributes[:'max_preview_session_bytes']
146
188
  end
147
189
 
190
+ if attributes.key?(:'max_revertable_bytes')
191
+ self.max_revertable_bytes = attributes[:'max_revertable_bytes']
192
+ end
193
+
148
194
  if attributes.key?(:'max_search_results')
149
195
  self.max_search_results = attributes[:'max_search_results']
150
196
  end
@@ -153,6 +199,14 @@ module UltracartClient
153
199
  self.max_template_bytes = attributes[:'max_template_bytes']
154
200
  end
155
201
 
202
+ if attributes.key?(:'max_text_read_bytes')
203
+ self.max_text_read_bytes = attributes[:'max_text_read_bytes']
204
+ end
205
+
206
+ if attributes.key?(:'max_video_bytes')
207
+ self.max_video_bytes = attributes[:'max_video_bytes']
208
+ end
209
+
156
210
  if attributes.key?(:'max_widget_ids_per_request')
157
211
  self.max_widget_ids_per_request = attributes[:'max_widget_ids_per_request']
158
212
  end
@@ -199,10 +253,16 @@ module UltracartClient
199
253
  container_manager_version == o.container_manager_version &&
200
254
  container_versions_retained == o.container_versions_retained &&
201
255
  element_count == o.element_count &&
256
+ max_asset_bytes == o.max_asset_bytes &&
202
257
  max_cjson_bytes == o.max_cjson_bytes &&
258
+ max_directory_entries == o.max_directory_entries &&
259
+ max_library_results_per_page == o.max_library_results_per_page &&
203
260
  max_preview_session_bytes == o.max_preview_session_bytes &&
261
+ max_revertable_bytes == o.max_revertable_bytes &&
204
262
  max_search_results == o.max_search_results &&
205
263
  max_template_bytes == o.max_template_bytes &&
264
+ max_text_read_bytes == o.max_text_read_bytes &&
265
+ max_video_bytes == o.max_video_bytes &&
206
266
  max_widget_ids_per_request == o.max_widget_ids_per_request &&
207
267
  preview_session_ttl_seconds == o.preview_session_ttl_seconds &&
208
268
  release == o.release
@@ -217,7 +277,7 @@ module UltracartClient
217
277
  # Calculates hash code according to all attributes.
218
278
  # @return [Integer] Hash code
219
279
  def hash
220
- [container_manager_version, container_versions_retained, element_count, max_cjson_bytes, max_preview_session_bytes, max_search_results, max_template_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
280
+ [container_manager_version, container_versions_retained, element_count, max_asset_bytes, max_cjson_bytes, max_directory_entries, max_library_results_per_page, max_preview_session_bytes, max_revertable_bytes, max_search_results, max_template_bytes, max_text_read_bytes, max_video_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
221
281
  end
222
282
 
223
283
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.145'
14
+ VERSION = '4.1.147'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.145
4
+ version: 4.1.147
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-02 00:00:00.000000000 Z
11
+ date: 2026-09-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus