ultracart_api 4.1.144 → 4.1.146

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: 13b9d39d06ac6b0264998815c54095b46e5f2937017216b655170327a16c8fec
4
- data.tar.gz: e6dc9b0d31c8b1406bb234d666668b21ab36ec5ea897ff32df8a845784e62af6
3
+ metadata.gz: '036368fdee38b26ea356d002fd6d655ea9f4759ed13b01d66fd7b99737452573'
4
+ data.tar.gz: e5ee50e86b0e48f43fe29c513f6d90f0fc8c0de9d2b97f46ca3686a90cf46a2c
5
5
  SHA512:
6
- metadata.gz: 7898973f5918fa512d645190944553db8e00efddab71b7ad128647e234decdb4f1cb40604f7844ca92e02d28bfd2ade4b3cae38e12c9696a6fb915142f5042b1
7
- data.tar.gz: 2dcfdb984be83191ad63ba1e1d0f7e79155cb7ddaa7bc16e918a9ec77395b93636153c8e82b98e6682c186d36717ba5de9ad22f8bcdb290045c55e3195353c7c
6
+ metadata.gz: 35da706c21aea107d4af2816c082c18c9dcf0198fc776d6b8a2318cbdcb9ec849b5440fd9b8e284680e58c814ded1754288b4234eef3323f9786512097d06723
7
+ data.tar.gz: 34ac9ffd5893e93a84f325120c40e03a5e2e0a64fd2195cae5af3aabfb353b21af54c2c9f73e4d906d5af361822f35482e6971f0c041c3889a51d5be20f3b91a
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.144
10
+ - Package version: 4.1.146
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.144'
19
+ gem 'ultracart_api', '4.1.146'
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.146 | 09/03/2026 | sfvb - internal testing |
1931
+ | 4.1.145 | 09/02/2026 | sfvb - internal testing |
1930
1932
  | 4.1.144 | 09/02/2026 | sfvb - internal testing |
1931
1933
  | 4.1.143 | 09/02/2026 | sfvb - internal development |
1932
1934
  | 4.1.142 | 08/26/2026 | sfvb - internal test |
data/docs/SfvbApi.md CHANGED
@@ -752,6 +752,8 @@ end
752
752
 
753
753
  URL that renders a preview session
754
754
 
755
+ Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
756
+
755
757
 
756
758
  ### Examples
757
759
 
@@ -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. Present for email, postcardfront and postcardback. Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container. Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports. | [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
 
@@ -9,7 +9,7 @@
9
9
  | **preview_session_id** | **String** | The preview session id used. | [optional] |
10
10
  | **preview_url** | **String** | URL that renders the storefront page with the preview session's containers substituted for the stored ones. | [optional] |
11
11
  | **requires_browser_session** | **Boolean** | Always true. The preview only applies to a request carrying the UltraCart admin session cookie of the user who authorised this token. Fetched without it, the URL returns the LIVE page with a 200 and no error, so a successful fetch is not evidence the preview was applied. Present this URL for a human to open; do not fetch it. | [optional] |
12
- | **shareable** | **Boolean** | Always false. The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. | [optional] |
12
+ | **shareable** | **Boolean** | The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false. Do not test it for equality with false. usage_note carries the same warning as a string and does survive. | [optional] |
13
13
  | **usage_note** | **String** | Plain language restatement of the two flags above, safe to show a user. | [optional] |
14
14
 
15
15
  ## Example
@@ -955,6 +955,7 @@ module UltracartClient
955
955
  end
956
956
 
957
957
  # URL that renders a preview session
958
+ # Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
958
959
  # @param storefront_oid [Integer]
959
960
  # @param preview_session_id [String]
960
961
  # @param [Hash] opts the optional parameters
@@ -966,6 +967,7 @@ module UltracartClient
966
967
  end
967
968
 
968
969
  # URL that renders a preview session
970
+ # Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
969
971
  # @param storefront_oid [Integer]
970
972
  # @param preview_session_id [String]
971
973
  # @param [Hash] opts the optional parameters
@@ -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. Present for email, postcardfront and postcardback. Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container. Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
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.
@@ -30,7 +30,7 @@ module UltracartClient
30
30
  # Always true. The preview only applies to a request carrying the UltraCart admin session cookie of the user who authorised this token. Fetched without it, the URL returns the LIVE page with a 200 and no error, so a successful fetch is not evidence the preview was applied. Present this URL for a human to open; do not fetch it.
31
31
  attr_accessor :requires_browser_session
32
32
 
33
- # Always false. The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.
33
+ # The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false. Do not test it for equality with false. usage_note carries the same warning as a string and does survive.
34
34
  attr_accessor :shareable
35
35
 
36
36
  # Plain language restatement of the two flags above, safe to show a user.
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.144'
14
+ VERSION = '4.1.146'
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.144
4
+ version: 4.1.146
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-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus