ultracart_api 4.1.254 → 4.1.255

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: 42d685924ad17c46598a304075febe9a3904bd694c2305181a6bc9637055744d
4
- data.tar.gz: 52c6a1cfd85fd4bef13748d38c68390c533110231f55cafc3784e129d14a1d47
3
+ metadata.gz: de20369b5d49262419ae7c545016a4591e4b8a69f194debf5e4bb5b70962677c
4
+ data.tar.gz: 2756b34d5d7d7673826bfdc64b971ea33829f4f4b34e6e8e6f769d914a657090
5
5
  SHA512:
6
- metadata.gz: bb24259c7d3f32abff75df743339ec0903bd3d4cfa6e6af9087fb8958f0c2966b93be48fd32d4307a03326d4346a88d8f0efe854e78e70af0bd1fb54f869d1b1
7
- data.tar.gz: 65b75bbb659dc43019066328075e72a010814fac034d99e8b7a1069ba2184867b0bfbe84d4a4a98dd9154f8ae3bda9ba4ba74cf97acc377ccc6e9bd5cd892eda
6
+ metadata.gz: 57fc697e759445ea80f13a132316f6fb55c4d7acc80ed02a70cb1dcab6e6ef5cf610795194a6f8fb1af8af74483ce1277f5621d0b4dbf3d142b3455d9f08ecb3
7
+ data.tar.gz: e7c95d5ecf5368c14e56ac75190dd3e23517cc0b0305d6291aa26ac73959100589de5316582a94d7731499d318fc0d14413d4ba8b67059ca3e5695bd62175d77
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.254
10
+ - Package version: 4.1.255
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.254'
19
+ gem 'ultracart_api', '4.1.255'
20
20
  ```
21
21
 
22
22
  install:
@@ -660,6 +660,8 @@ Class | Method | HTTP request | Description
660
660
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
661
661
  *UltracartClient::SfvbApi* | [**insert_sfvb_docs_gap**](docs/SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report
662
662
  *UltracartClient::SfvbApi* | [**insert_sfvb_item_child**](docs/SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations
663
+ *UltracartClient::SfvbApi* | [**insert_sfvb_location**](docs/SfvbApi.md#insert_sfvb_location) | **POST** /sfvb/location | Add the caller's address to this StoreFront CLI sign-in
664
+ *UltracartClient::SfvbApi* | [**insert_sfvb_location_approval**](docs/SfvbApi.md#insert_sfvb_location_approval) | **POST** /sfvb/location/approval | Ask to use this StoreFront CLI sign-in from the caller's address
663
665
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
664
666
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
665
667
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
@@ -2031,6 +2033,7 @@ Class | Method | HTTP request | Description
2031
2033
  - [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
2032
2034
  - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
2033
2035
  - [UltracartClient::SfvbCliAccess](docs/SfvbCliAccess.md)
2036
+ - [UltracartClient::SfvbCliLocation](docs/SfvbCliLocation.md)
2034
2037
  - [UltracartClient::SfvbCliVersion](docs/SfvbCliVersion.md)
2035
2038
  - [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
2036
2039
  - [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
@@ -2598,6 +2601,7 @@ Not every change is committed to every SDK.
2598
2601
 
2599
2602
  | Version | Date | Comments |
2600
2603
  | --: | :-: | --- |
2604
+ | 4.1.255 | 11/17/2026 | sfvb internal testing |
2601
2605
  | 4.1.254 | 11/15/2026 | sfvb internal testing |
2602
2606
  | 4.1.253 | 11/13/2026 | sfvb internal testing |
2603
2607
  | 4.1.252 | 11/12/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -188,6 +188,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
188
188
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
189
189
  | [**insert_sfvb_docs_gap**](SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report |
190
190
  | [**insert_sfvb_item_child**](SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations |
191
+ | [**insert_sfvb_location**](SfvbApi.md#insert_sfvb_location) | **POST** /sfvb/location | Add the caller's address to this StoreFront CLI sign-in |
192
+ | [**insert_sfvb_location_approval**](SfvbApi.md#insert_sfvb_location_approval) | **POST** /sfvb/location/approval | Ask to use this StoreFront CLI sign-in from the caller's address |
191
193
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
192
194
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
193
195
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
@@ -10300,6 +10302,110 @@ end
10300
10302
  - **Accept**: application/json
10301
10303
 
10302
10304
 
10305
+ ## insert_sfvb_location
10306
+
10307
+ > insert_sfvb_location(opts)
10308
+
10309
+ Add the caller's address to this StoreFront CLI sign-in
10310
+
10311
+ Spends an approved cli.location approval, named in the Approval-Id header, from the address it was asked for. From then on the sign-in may be used from that address until it ends. An approval asked for from another address is refused with sfvb.approval_mismatch.
10312
+
10313
+
10314
+ ### Examples
10315
+
10316
+
10317
+ (No example for this operation).
10318
+
10319
+
10320
+ #### Using the insert_sfvb_location_with_http_info variant
10321
+
10322
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
10323
+
10324
+ > <Array(nil, Integer, Hash)> insert_sfvb_location_with_http_info(opts)
10325
+
10326
+ ```ruby
10327
+ begin
10328
+ # Add the caller's address to this StoreFront CLI sign-in
10329
+ data, status_code, headers = api_instance.insert_sfvb_location_with_http_info(opts)
10330
+ p status_code # => 2xx
10331
+ p headers # => { ... }
10332
+ p data # => nil
10333
+ rescue UltracartClient::ApiError => e
10334
+ puts "Error when calling SfvbApi->insert_sfvb_location_with_http_info: #{e}"
10335
+ end
10336
+ ```
10337
+
10338
+ ### Parameters
10339
+
10340
+ | Name | Type | Description | Notes |
10341
+ | ---- | ---- | ----------- | ----- |
10342
+ | **approval_id** | **String** | The approval_id of an approved cli.location request asked for from this address. See POST /sfvb/location/approval. | [optional] |
10343
+
10344
+ ### Return type
10345
+
10346
+ nil (empty response body)
10347
+
10348
+ ### Authorization
10349
+
10350
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
10351
+
10352
+ ### HTTP request headers
10353
+
10354
+ - **Content-Type**: Not defined
10355
+ - **Accept**: application/json
10356
+
10357
+
10358
+ ## insert_sfvb_location_approval
10359
+
10360
+ > <SfvbApproval> insert_sfvb_location_approval
10361
+
10362
+ Ask to use this StoreFront CLI sign-in from the caller's address
10363
+
10364
+ For a StoreFront CLI sign-in refused with sfvb.location_approval_required. Asks the person who signed in to approve the address this call comes from (a cli.location approval). Show them approval_url and user_code, poll GET approvals/{approval_id}, and once it is approved call POST location from the same address with the approval_id in the Approval-Id header. Asking again returns the pending request (200). The person is also emailed, so a request they didn't expect warns them.
10365
+
10366
+
10367
+ ### Examples
10368
+
10369
+
10370
+ (No example for this operation).
10371
+
10372
+
10373
+ #### Using the insert_sfvb_location_approval_with_http_info variant
10374
+
10375
+ This returns an Array which contains the response data, status code and headers.
10376
+
10377
+ > <Array(<SfvbApproval>, Integer, Hash)> insert_sfvb_location_approval_with_http_info
10378
+
10379
+ ```ruby
10380
+ begin
10381
+ # Ask to use this StoreFront CLI sign-in from the caller's address
10382
+ data, status_code, headers = api_instance.insert_sfvb_location_approval_with_http_info
10383
+ p status_code # => 2xx
10384
+ p headers # => { ... }
10385
+ p data # => <SfvbApproval>
10386
+ rescue UltracartClient::ApiError => e
10387
+ puts "Error when calling SfvbApi->insert_sfvb_location_approval_with_http_info: #{e}"
10388
+ end
10389
+ ```
10390
+
10391
+ ### Parameters
10392
+
10393
+ This endpoint does not need any parameter.
10394
+
10395
+ ### Return type
10396
+
10397
+ [**SfvbApproval**](SfvbApproval.md)
10398
+
10399
+ ### Authorization
10400
+
10401
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
10402
+
10403
+ ### HTTP request headers
10404
+
10405
+ - **Content-Type**: Not defined
10406
+ - **Accept**: application/json
10407
+
10408
+
10303
10409
  ## insert_sfvb_page
10304
10410
 
10305
10411
  > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
@@ -13,6 +13,7 @@
13
13
  | **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
14
14
  | **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account&#39;s esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
15
15
  | **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
16
+ | **ip** | **String** | For cli.location, the IPv4 address the StoreFront CLI sign-in asks to be used from. Set by the server from the caller&#39;s own address, never by the caller. | [optional] |
16
17
  | **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
17
18
  | **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
18
19
  | **new_path** | **String** | For page.move, where the page goes, exactly as the move will send it. path is the page as it is now. | [optional] |
@@ -49,6 +50,7 @@ instance = UltracartClient::SfvbApprovalParams.new(
49
50
  domain: null,
50
51
  esp_twilio_uuid: null,
51
52
  experiment_oid: null,
53
+ ip: null,
52
54
  item_count: null,
53
55
  merchant_item_oid: null,
54
56
  new_path: null,
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbCliLocation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ip** | **String** | The IPv4 address this call came from, as UltraCart sees it. | [optional] |
8
+ | **trusted** | **Boolean** | True when the sign-in may be used from this address. When false (omitted), ask for approval with POST /sfvb/location/approval. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbCliLocation.new(
16
+ ip: null,
17
+ trusted: null
18
+ )
19
+ ```
20
+
@@ -14,6 +14,7 @@
14
14
  | **can_read_items** | **Boolean** | True when this token may read item data - the item, its pricing, pre-order and related items. Needs can_read, and the UltraCart user behind the token must hold View Items or Edit Items. A token with no user is judged on its scopes alone. | [optional] |
15
15
  | **can_write** | **Boolean** | True when this token may write. Writing a target that is not currently live needs only this. | [optional] |
16
16
  | **cli_access** | [**SfvbCliAccess**](SfvbCliAccess.md) | | [optional] |
17
+ | **cli_location** | [**SfvbCliLocation**](SfvbCliLocation.md) | | [optional] |
17
18
  | **cli_version** | [**SfvbCliVersion**](SfvbCliVersion.md) | | [optional] |
18
19
  | **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
19
20
  | **login** | **String** | Login of the user who approved this token. Populated for device flow tokens; null for plain API key credentials. | [optional] |
@@ -39,6 +40,7 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
39
40
  can_read_items: null,
40
41
  can_write: null,
41
42
  cli_access: null,
43
+ cli_location: null,
42
44
  cli_version: null,
43
45
  device_scope: null,
44
46
  login: null,
@@ -13162,6 +13162,125 @@ module UltracartClient
13162
13162
  return data, status_code, headers
13163
13163
  end
13164
13164
 
13165
+ # Add the caller's address to this StoreFront CLI sign-in
13166
+ # Spends an approved cli.location approval, named in the Approval-Id header, from the address it was asked for. From then on the sign-in may be used from that address until it ends. An approval asked for from another address is refused with sfvb.approval_mismatch.
13167
+ # @param [Hash] opts the optional parameters
13168
+ # @option opts [String] :approval_id The approval_id of an approved cli.location request asked for from this address. See POST /sfvb/location/approval.
13169
+ # @return [nil]
13170
+ def insert_sfvb_location(opts = {})
13171
+ insert_sfvb_location_with_http_info(opts)
13172
+ nil
13173
+ end
13174
+
13175
+ # Add the caller&#39;s address to this StoreFront CLI sign-in
13176
+ # Spends an approved cli.location approval, named in the Approval-Id header, from the address it was asked for. From then on the sign-in may be used from that address until it ends. An approval asked for from another address is refused with sfvb.approval_mismatch.
13177
+ # @param [Hash] opts the optional parameters
13178
+ # @option opts [String] :approval_id The approval_id of an approved cli.location request asked for from this address. See POST /sfvb/location/approval.
13179
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
13180
+ def insert_sfvb_location_with_http_info(opts = {})
13181
+ if @api_client.config.debugging
13182
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_location ...'
13183
+ end
13184
+ # resource path
13185
+ local_var_path = '/sfvb/location'
13186
+
13187
+ # query parameters
13188
+ query_params = opts[:query_params] || {}
13189
+
13190
+ # header parameters
13191
+ header_params = opts[:header_params] || {}
13192
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
13193
+ # HTTP header 'Accept' (if needed)
13194
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13195
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
13196
+
13197
+ # form parameters
13198
+ form_params = opts[:form_params] || {}
13199
+
13200
+ # http body (model)
13201
+ post_body = opts[:debug_body]
13202
+
13203
+ # return_type
13204
+ return_type = opts[:debug_return_type]
13205
+
13206
+ # auth_names
13207
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
13208
+
13209
+ new_options = opts.merge(
13210
+ :operation => :"SfvbApi.insert_sfvb_location",
13211
+ :header_params => header_params,
13212
+ :query_params => query_params,
13213
+ :form_params => form_params,
13214
+ :body => post_body,
13215
+ :auth_names => auth_names,
13216
+ :return_type => return_type
13217
+ )
13218
+
13219
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13220
+ if @api_client.config.debugging
13221
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13222
+ end
13223
+ return data, status_code, headers
13224
+ end
13225
+
13226
+ # Ask to use this StoreFront CLI sign-in from the caller's address
13227
+ # For a StoreFront CLI sign-in refused with sfvb.location_approval_required. Asks the person who signed in to approve the address this call comes from (a cli.location approval). Show them approval_url and user_code, poll GET approvals/{approval_id}, and once it is approved call POST location from the same address with the approval_id in the Approval-Id header. Asking again returns the pending request (200). The person is also emailed, so a request they didn't expect warns them.
13228
+ # @param [Hash] opts the optional parameters
13229
+ # @return [SfvbApproval]
13230
+ def insert_sfvb_location_approval(opts = {})
13231
+ data, _status_code, _headers = insert_sfvb_location_approval_with_http_info(opts)
13232
+ data
13233
+ end
13234
+
13235
+ # Ask to use this StoreFront CLI sign-in from the caller&#39;s address
13236
+ # For a StoreFront CLI sign-in refused with sfvb.location_approval_required. Asks the person who signed in to approve the address this call comes from (a cli.location approval). Show them approval_url and user_code, poll GET approvals/{approval_id}, and once it is approved call POST location from the same address with the approval_id in the Approval-Id header. Asking again returns the pending request (200). The person is also emailed, so a request they didn&#39;t expect warns them.
13237
+ # @param [Hash] opts the optional parameters
13238
+ # @return [Array<(SfvbApproval, Integer, Hash)>] SfvbApproval data, response status code and response headers
13239
+ def insert_sfvb_location_approval_with_http_info(opts = {})
13240
+ if @api_client.config.debugging
13241
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_location_approval ...'
13242
+ end
13243
+ # resource path
13244
+ local_var_path = '/sfvb/location/approval'
13245
+
13246
+ # query parameters
13247
+ query_params = opts[:query_params] || {}
13248
+
13249
+ # header parameters
13250
+ header_params = opts[:header_params] || {}
13251
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
13252
+ # HTTP header 'Accept' (if needed)
13253
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13254
+
13255
+ # form parameters
13256
+ form_params = opts[:form_params] || {}
13257
+
13258
+ # http body (model)
13259
+ post_body = opts[:debug_body]
13260
+
13261
+ # return_type
13262
+ return_type = opts[:debug_return_type] || 'SfvbApproval'
13263
+
13264
+ # auth_names
13265
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
13266
+
13267
+ new_options = opts.merge(
13268
+ :operation => :"SfvbApi.insert_sfvb_location_approval",
13269
+ :header_params => header_params,
13270
+ :query_params => query_params,
13271
+ :form_params => form_params,
13272
+ :body => post_body,
13273
+ :auth_names => auth_names,
13274
+ :return_type => return_type
13275
+ )
13276
+
13277
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13278
+ if @api_client.config.debugging
13279
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_location_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13280
+ end
13281
+ return data, status_code, headers
13282
+ end
13283
+
13165
13284
  # Create a page
13166
13285
  # Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
13167
13286
  # @param storefront_oid [Integer]
@@ -283,7 +283,7 @@ module UltracartClient
283
283
  # Check to see if the all the properties in the model are valid
284
284
  # @return true if the model is valid
285
285
  def valid?
286
- action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move"])
286
+ action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move", "cli.location"])
287
287
  return false unless action_validator.valid?(@action)
288
288
  true
289
289
  end
@@ -291,7 +291,7 @@ module UltracartClient
291
291
  # Custom attribute writer method checking allowed values (enum).
292
292
  # @param [Object] action Object to be assigned
293
293
  def action=(action)
294
- validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move"])
294
+ validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill", "page.move", "cli.location"])
295
295
  unless validator.valid?(action)
296
296
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
297
297
  end
@@ -42,6 +42,9 @@ module UltracartClient
42
42
  # For experiment.end, the experiment to end.
43
43
  attr_accessor :experiment_oid
44
44
 
45
+ # For cli.location, the IPv4 address the StoreFront CLI sign-in asks to be used from. Set by the server from the caller's own address, never by the caller.
46
+ attr_accessor :ip
47
+
45
48
  # For item.attribute_batch, how many items the batch would change when it was requested. Set by the server.
46
49
  attr_accessor :item_count
47
50
 
@@ -136,6 +139,7 @@ module UltracartClient
136
139
  :'domain' => :'domain',
137
140
  :'esp_twilio_uuid' => :'esp_twilio_uuid',
138
141
  :'experiment_oid' => :'experiment_oid',
142
+ :'ip' => :'ip',
139
143
  :'item_count' => :'item_count',
140
144
  :'merchant_item_oid' => :'merchant_item_oid',
141
145
  :'new_path' => :'new_path',
@@ -176,6 +180,7 @@ module UltracartClient
176
180
  :'domain' => :'String',
177
181
  :'esp_twilio_uuid' => :'String',
178
182
  :'experiment_oid' => :'Integer',
183
+ :'ip' => :'String',
179
184
  :'item_count' => :'Integer',
180
185
  :'merchant_item_oid' => :'Integer',
181
186
  :'new_path' => :'String',
@@ -258,6 +263,10 @@ module UltracartClient
258
263
  self.experiment_oid = attributes[:'experiment_oid']
259
264
  end
260
265
 
266
+ if attributes.key?(:'ip')
267
+ self.ip = attributes[:'ip']
268
+ end
269
+
261
270
  if attributes.key?(:'item_count')
262
271
  self.item_count = attributes[:'item_count']
263
272
  end
@@ -378,6 +387,7 @@ module UltracartClient
378
387
  domain == o.domain &&
379
388
  esp_twilio_uuid == o.esp_twilio_uuid &&
380
389
  experiment_oid == o.experiment_oid &&
390
+ ip == o.ip &&
381
391
  item_count == o.item_count &&
382
392
  merchant_item_oid == o.merchant_item_oid &&
383
393
  new_path == o.new_path &&
@@ -409,7 +419,7 @@ module UltracartClient
409
419
  # Calculates hash code according to all attributes.
410
420
  # @return [Integer] Hash code
411
421
  def hash
412
- [affiliate_network_oid, after_step_uuid, attribute_names, blog_post_oid, branch_step_uuid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, new_path, pages_moved, path, redirect_old_url, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, side, slot, step_uuid, tracking_provider, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
422
+ [affiliate_network_oid, after_step_uuid, attribute_names, blog_post_oid, branch_step_uuid, content_sha256, domain, esp_twilio_uuid, experiment_oid, ip, item_count, merchant_item_oid, new_path, pages_moved, path, redirect_old_url, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, side, slot, step_uuid, tracking_provider, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
413
423
  end
414
424
 
415
425
  # Builds the object from hash
@@ -0,0 +1,230 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module UltracartClient
17
+ class SfvbCliLocation
18
+ # The IPv4 address this call came from, as UltraCart sees it.
19
+ attr_accessor :ip
20
+
21
+ # True when the sign-in may be used from this address. When false (omitted), ask for approval with POST /sfvb/location/approval.
22
+ attr_accessor :trusted
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'ip' => :'ip',
28
+ :'trusted' => :'trusted'
29
+ }
30
+ end
31
+
32
+ # Returns all the JSON keys this model knows about
33
+ def self.acceptable_attributes
34
+ attribute_map.values
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.openapi_types
39
+ {
40
+ :'ip' => :'String',
41
+ :'trusted' => :'Boolean'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbCliLocation` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbCliLocation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'ip')
67
+ self.ip = attributes[:'ip']
68
+ end
69
+
70
+ if attributes.key?(:'trusted')
71
+ self.trusted = attributes[:'trusted']
72
+ end
73
+ end
74
+
75
+ # Show invalid properties with the reasons. Usually used together with valid?
76
+ # @return Array for valid properties with the reasons
77
+ def list_invalid_properties
78
+ invalid_properties = Array.new
79
+ invalid_properties
80
+ end
81
+
82
+ # Check to see if the all the properties in the model are valid
83
+ # @return true if the model is valid
84
+ def valid?
85
+ true
86
+ end
87
+
88
+ # Checks equality by comparing each attribute.
89
+ # @param [Object] Object to be compared
90
+ def ==(o)
91
+ return true if self.equal?(o)
92
+ self.class == o.class &&
93
+ ip == o.ip &&
94
+ trusted == o.trusted
95
+ end
96
+
97
+ # @see the `==` method
98
+ # @param [Object] Object to be compared
99
+ def eql?(o)
100
+ self == o
101
+ end
102
+
103
+ # Calculates hash code according to all attributes.
104
+ # @return [Integer] Hash code
105
+ def hash
106
+ [ip, trusted].hash
107
+ end
108
+
109
+ # Builds the object from hash
110
+ # @param [Hash] attributes Model attributes in the form of hash
111
+ # @return [Object] Returns the model itself
112
+ def self.build_from_hash(attributes)
113
+ new.build_from_hash(attributes)
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def build_from_hash(attributes)
120
+ return nil unless attributes.is_a?(Hash)
121
+ attributes = attributes.transform_keys(&:to_sym)
122
+ self.class.openapi_types.each_pair do |key, type|
123
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
124
+ self.send("#{key}=", nil)
125
+ elsif type =~ /\AArray<(.*)>/i
126
+ # check to ensure the input is an array given that the attribute
127
+ # is documented as an array but the input is not
128
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
129
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
130
+ end
131
+ elsif !attributes[self.class.attribute_map[key]].nil?
132
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
133
+ end
134
+ end
135
+
136
+ self
137
+ end
138
+
139
+ # Deserializes the data based on type
140
+ # @param string type Data type
141
+ # @param string value Value to be deserialized
142
+ # @return [Object] Deserialized data
143
+ def _deserialize(type, value)
144
+ case type.to_sym
145
+ when :Time
146
+ Time.parse(value)
147
+ when :Date
148
+ Date.parse(value)
149
+ when :String
150
+ value.to_s
151
+ when :Integer
152
+ value.to_i
153
+ when :Float
154
+ value.to_f
155
+ when :Boolean
156
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
157
+ true
158
+ else
159
+ false
160
+ end
161
+ when :Object
162
+ # generic object (usually a Hash), return directly
163
+ value
164
+ when /\AArray<(?<inner_type>.+)>\z/
165
+ inner_type = Regexp.last_match[:inner_type]
166
+ value.map { |v| _deserialize(inner_type, v) }
167
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
168
+ k_type = Regexp.last_match[:k_type]
169
+ v_type = Regexp.last_match[:v_type]
170
+ {}.tap do |hash|
171
+ value.each do |k, v|
172
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
173
+ end
174
+ end
175
+ else # model
176
+ # models (e.g. Pet) or oneOf
177
+ klass = UltracartClient.const_get(type)
178
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
179
+ end
180
+ end
181
+
182
+ # Returns the string representation of the object
183
+ # @return [String] String presentation of the object
184
+ def to_s
185
+ to_hash.to_s
186
+ end
187
+
188
+ # to_body is an alias to to_hash (backward compatibility)
189
+ # @return [Hash] Returns the object in the form of hash
190
+ def to_body
191
+ to_hash
192
+ end
193
+
194
+ # Returns the object in the form of hash
195
+ # @return [Hash] Returns the object in the form of hash
196
+ def to_hash
197
+ hash = {}
198
+ self.class.attribute_map.each_pair do |attr, param|
199
+ value = self.send(attr)
200
+ if value.nil?
201
+ is_nullable = self.class.openapi_nullable.include?(attr)
202
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
203
+ end
204
+
205
+ hash[param] = _to_hash(value)
206
+ end
207
+ hash
208
+ end
209
+
210
+ # Outputs non-array value in the form of hash
211
+ # For object, use to_hash. Otherwise, just return the value
212
+ # @param [Object] value Any valid value
213
+ # @return [Hash] Returns the value in the form of hash
214
+ def _to_hash(value)
215
+ if value.is_a?(Array)
216
+ value.compact.map { |v| _to_hash(v) }
217
+ elsif value.is_a?(Hash)
218
+ {}.tap do |hash|
219
+ value.each { |k, v| hash[k] = _to_hash(v) }
220
+ end
221
+ elsif value.respond_to? :to_hash
222
+ value.to_hash
223
+ else
224
+ value
225
+ end
226
+ end
227
+
228
+ end
229
+
230
+ end
@@ -44,6 +44,8 @@ module UltracartClient
44
44
 
45
45
  attr_accessor :cli_access
46
46
 
47
+ attr_accessor :cli_location
48
+
47
49
  attr_accessor :cli_version
48
50
 
49
51
  # Device scope name, when this is a device flow token.
@@ -80,6 +82,7 @@ module UltracartClient
80
82
  :'can_read_items' => :'can_read_items',
81
83
  :'can_write' => :'can_write',
82
84
  :'cli_access' => :'cli_access',
85
+ :'cli_location' => :'cli_location',
83
86
  :'cli_version' => :'cli_version',
84
87
  :'device_scope' => :'device_scope',
85
88
  :'login' => :'login',
@@ -109,6 +112,7 @@ module UltracartClient
109
112
  :'can_read_items' => :'Boolean',
110
113
  :'can_write' => :'Boolean',
111
114
  :'cli_access' => :'SfvbCliAccess',
115
+ :'cli_location' => :'SfvbCliLocation',
112
116
  :'cli_version' => :'SfvbCliVersion',
113
117
  :'device_scope' => :'String',
114
118
  :'login' => :'String',
@@ -181,6 +185,10 @@ module UltracartClient
181
185
  self.cli_access = attributes[:'cli_access']
182
186
  end
183
187
 
188
+ if attributes.key?(:'cli_location')
189
+ self.cli_location = attributes[:'cli_location']
190
+ end
191
+
184
192
  if attributes.key?(:'cli_version')
185
193
  self.cli_version = attributes[:'cli_version']
186
194
  end
@@ -246,6 +254,7 @@ module UltracartClient
246
254
  can_read_items == o.can_read_items &&
247
255
  can_write == o.can_write &&
248
256
  cli_access == o.cli_access &&
257
+ cli_location == o.cli_location &&
249
258
  cli_version == o.cli_version &&
250
259
  device_scope == o.device_scope &&
251
260
  login == o.login &&
@@ -265,7 +274,7 @@ module UltracartClient
265
274
  # Calculates hash code according to all attributes.
266
275
  # @return [Integer] Hash code
267
276
  def hash
268
- [acting_as_user, application_name, authentication_type, can_edit_items, can_publish, can_publish_public, can_read, can_read_items, can_write, cli_access, cli_version, device_scope, login, merchant_id, scopes, storefronts, storefronts_withheld, user_name].hash
277
+ [acting_as_user, application_name, authentication_type, can_edit_items, can_publish, can_publish_public, can_read, can_read_items, can_write, cli_access, cli_location, cli_version, device_scope, login, merchant_id, scopes, storefronts, storefronts_withheld, user_name].hash
269
278
  end
270
279
 
271
280
  # 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.254'
14
+ VERSION = '4.1.255'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -1005,6 +1005,7 @@ require 'ultracart_api/models/sfvb_campaign_membership'
1005
1005
  require 'ultracart_api/models/sfvb_campaign_write_request'
1006
1006
  require 'ultracart_api/models/sfvb_campaigns_response'
1007
1007
  require 'ultracart_api/models/sfvb_cli_access'
1008
+ require 'ultracart_api/models/sfvb_cli_location'
1008
1009
  require 'ultracart_api/models/sfvb_cli_version'
1009
1010
  require 'ultracart_api/models/sfvb_code_library_email'
1010
1011
  require 'ultracart_api/models/sfvb_code_library_emails_response'
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.254
4
+ version: 4.1.255
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-11-15 00:00:00.000000000 Z
11
+ date: 2026-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -1067,6 +1067,7 @@ files:
1067
1067
  - docs/SfvbCampaignWriteRequest.md
1068
1068
  - docs/SfvbCampaignsResponse.md
1069
1069
  - docs/SfvbCliAccess.md
1070
+ - docs/SfvbCliLocation.md
1070
1071
  - docs/SfvbCliVersion.md
1071
1072
  - docs/SfvbCodeLibraryEmail.md
1072
1073
  - docs/SfvbCodeLibraryEmailsResponse.md
@@ -2580,6 +2581,7 @@ files:
2580
2581
  - lib/ultracart_api/models/sfvb_campaign_write_request.rb
2581
2582
  - lib/ultracart_api/models/sfvb_campaigns_response.rb
2582
2583
  - lib/ultracart_api/models/sfvb_cli_access.rb
2584
+ - lib/ultracart_api/models/sfvb_cli_location.rb
2583
2585
  - lib/ultracart_api/models/sfvb_cli_version.rb
2584
2586
  - lib/ultracart_api/models/sfvb_code_library_email.rb
2585
2587
  - lib/ultracart_api/models/sfvb_code_library_emails_response.rb