ultracart_api 4.1.255 → 4.1.256

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: de20369b5d49262419ae7c545016a4591e4b8a69f194debf5e4bb5b70962677c
4
- data.tar.gz: 2756b34d5d7d7673826bfdc64b971ea33829f4f4b34e6e8e6f769d914a657090
3
+ metadata.gz: ec349d6c6f2eb57d192bfede5efd532e149f528dd13681e1da2a59412d406448
4
+ data.tar.gz: a0f70e6b688e8dbe1c96367b5db2892ba2d5fb4097a7a93db23f069bca71aa97
5
5
  SHA512:
6
- metadata.gz: 57fc697e759445ea80f13a132316f6fb55c4d7acc80ed02a70cb1dcab6e6ef5cf610795194a6f8fb1af8af74483ce1277f5621d0b4dbf3d142b3455d9f08ecb3
7
- data.tar.gz: e7c95d5ecf5368c14e56ac75190dd3e23517cc0b0305d6291aa26ac73959100589de5316582a94d7731499d318fc0d14413d4ba8b67059ca3e5695bd62175d77
6
+ metadata.gz: 61ed992b889b0f708e32522a565c1a72538d4210efe9b5f0e76e6cd992ce889a2f47e389bb474ab4e6bd455b2f11bf362edccfe825ae87126a640d073ead9eb5
7
+ data.tar.gz: fcf8b0b15dbd9a046b4628ef361f5b0108eabbfa439b620c8e5e4dd7de82a0574c63f3ed15e5a51c90c5d3736619b2b27da5b2f5932471c2a21ed2db699427ae
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.255
10
+ - Package version: 4.1.256
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.255'
19
+ gem 'ultracart_api', '4.1.256'
20
20
  ```
21
21
 
22
22
  install:
@@ -622,6 +622,7 @@ Class | Method | HTTP request | Description
622
622
  *UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
623
623
  *UltracartClient::SfvbApi* | [**get_sfvb_sequence_step_dispatch_logs**](docs/SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts
624
624
  *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
625
+ *UltracartClient::SfvbApi* | [**get_sfvb_session**](docs/SfvbApi.md#get_sfvb_session) | **GET** /sfvb/session | Who this token is
625
626
  *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
626
627
  *UltracartClient::SfvbApi* | [**get_sfvb_site_seo**](docs/SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings
627
628
  *UltracartClient::SfvbApi* | [**get_sfvb_sitemaps**](docs/SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt
@@ -644,7 +645,6 @@ Class | Method | HTTP request | Description
644
645
  *UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcode**](docs/SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode
645
646
  *UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcodes**](docs/SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes
646
647
  *UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
647
- *UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
648
648
  *UltracartClient::SfvbApi* | [**ignore_sfvb_not_found_entry**](docs/SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path
649
649
  *UltracartClient::SfvbApi* | [**import_sfvb_comms_provider_lists**](docs/SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider
650
650
  *UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
@@ -2601,6 +2601,7 @@ Not every change is committed to every SDK.
2601
2601
 
2602
2602
  | Version | Date | Comments |
2603
2603
  | --: | :-: | --- |
2604
+ | 4.1.256 | 11/17/2026 | sfvb internal testing |
2604
2605
  | 4.1.255 | 11/17/2026 | sfvb internal testing |
2605
2606
  | 4.1.254 | 11/15/2026 | sfvb internal testing |
2606
2607
  | 4.1.253 | 11/13/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -150,6 +150,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
150
150
  | [**get_sfvb_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
151
151
  | [**get_sfvb_sequence_step_dispatch_logs**](SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts |
152
152
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
153
+ | [**get_sfvb_session**](SfvbApi.md#get_sfvb_session) | **GET** /sfvb/session | Who this token is |
153
154
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
154
155
  | [**get_sfvb_site_seo**](SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings |
155
156
  | [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
@@ -172,7 +173,6 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
172
173
  | [**get_sfvb_utm_shortcode**](SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode |
173
174
  | [**get_sfvb_utm_shortcodes**](SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes |
174
175
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
175
- | [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
176
176
  | [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
177
177
  | [**import_sfvb_comms_provider_lists**](SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider |
178
178
  | [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
@@ -8250,6 +8250,57 @@ end
8250
8250
  - **Accept**: application/json
8251
8251
 
8252
8252
 
8253
+ ## get_sfvb_session
8254
+
8255
+ > <SfvbWhoamiResponse> get_sfvb_session
8256
+
8257
+ Who this token is
8258
+
8259
+ Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
8260
+
8261
+
8262
+ ### Examples
8263
+
8264
+
8265
+ (No example for this operation).
8266
+
8267
+
8268
+ #### Using the get_sfvb_session_with_http_info variant
8269
+
8270
+ This returns an Array which contains the response data, status code and headers.
8271
+
8272
+ > <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_session_with_http_info
8273
+
8274
+ ```ruby
8275
+ begin
8276
+ # Who this token is
8277
+ data, status_code, headers = api_instance.get_sfvb_session_with_http_info
8278
+ p status_code # => 2xx
8279
+ p headers # => { ... }
8280
+ p data # => <SfvbWhoamiResponse>
8281
+ rescue UltracartClient::ApiError => e
8282
+ puts "Error when calling SfvbApi->get_sfvb_session_with_http_info: #{e}"
8283
+ end
8284
+ ```
8285
+
8286
+ ### Parameters
8287
+
8288
+ This endpoint does not need any parameter.
8289
+
8290
+ ### Return type
8291
+
8292
+ [**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
8293
+
8294
+ ### Authorization
8295
+
8296
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8297
+
8298
+ ### HTTP request headers
8299
+
8300
+ - **Content-Type**: Not defined
8301
+ - **Accept**: application/json
8302
+
8303
+
8253
8304
  ## get_sfvb_site_attributes
8254
8305
 
8255
8306
  > <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
@@ -9441,57 +9492,6 @@ This endpoint does not need any parameter.
9441
9492
  - **Accept**: application/json
9442
9493
 
9443
9494
 
9444
- ## get_sfvb_whoami
9445
-
9446
- > <SfvbWhoamiResponse> get_sfvb_whoami
9447
-
9448
- Who this token is
9449
-
9450
- Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
9451
-
9452
-
9453
- ### Examples
9454
-
9455
-
9456
- (No example for this operation).
9457
-
9458
-
9459
- #### Using the get_sfvb_whoami_with_http_info variant
9460
-
9461
- This returns an Array which contains the response data, status code and headers.
9462
-
9463
- > <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_whoami_with_http_info
9464
-
9465
- ```ruby
9466
- begin
9467
- # Who this token is
9468
- data, status_code, headers = api_instance.get_sfvb_whoami_with_http_info
9469
- p status_code # => 2xx
9470
- p headers # => { ... }
9471
- p data # => <SfvbWhoamiResponse>
9472
- rescue UltracartClient::ApiError => e
9473
- puts "Error when calling SfvbApi->get_sfvb_whoami_with_http_info: #{e}"
9474
- end
9475
- ```
9476
-
9477
- ### Parameters
9478
-
9479
- This endpoint does not need any parameter.
9480
-
9481
- ### Return type
9482
-
9483
- [**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
9484
-
9485
- ### Authorization
9486
-
9487
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9488
-
9489
- ### HTTP request headers
9490
-
9491
- - **Content-Type**: Not defined
9492
- - **Accept**: application/json
9493
-
9494
-
9495
9495
  ## ignore_sfvb_not_found_entry
9496
9496
 
9497
9497
  > <SfvbNotFoundEntry> ignore_sfvb_not_found_entry(storefront_oid, not_found_id)
@@ -10475,6 +10475,64 @@ module UltracartClient
10475
10475
  return data, status_code, headers
10476
10476
  end
10477
10477
 
10478
+ # Who this token is
10479
+ # Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
10480
+ # @param [Hash] opts the optional parameters
10481
+ # @return [SfvbWhoamiResponse]
10482
+ def get_sfvb_session(opts = {})
10483
+ data, _status_code, _headers = get_sfvb_session_with_http_info(opts)
10484
+ data
10485
+ end
10486
+
10487
+ # Who this token is
10488
+ # Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
10489
+ # @param [Hash] opts the optional parameters
10490
+ # @return [Array<(SfvbWhoamiResponse, Integer, Hash)>] SfvbWhoamiResponse data, response status code and response headers
10491
+ def get_sfvb_session_with_http_info(opts = {})
10492
+ if @api_client.config.debugging
10493
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_session ...'
10494
+ end
10495
+ # resource path
10496
+ local_var_path = '/sfvb/session'
10497
+
10498
+ # query parameters
10499
+ query_params = opts[:query_params] || {}
10500
+
10501
+ # header parameters
10502
+ header_params = opts[:header_params] || {}
10503
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10504
+ # HTTP header 'Accept' (if needed)
10505
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10506
+
10507
+ # form parameters
10508
+ form_params = opts[:form_params] || {}
10509
+
10510
+ # http body (model)
10511
+ post_body = opts[:debug_body]
10512
+
10513
+ # return_type
10514
+ return_type = opts[:debug_return_type] || 'SfvbWhoamiResponse'
10515
+
10516
+ # auth_names
10517
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10518
+
10519
+ new_options = opts.merge(
10520
+ :operation => :"SfvbApi.get_sfvb_session",
10521
+ :header_params => header_params,
10522
+ :query_params => query_params,
10523
+ :form_params => form_params,
10524
+ :body => post_body,
10525
+ :auth_names => auth_names,
10526
+ :return_type => return_type
10527
+ )
10528
+
10529
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10530
+ if @api_client.config.debugging
10531
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10532
+ end
10533
+ return data, status_code, headers
10534
+ end
10535
+
10478
10536
  # Read a storefront's site attributes
10479
10537
  # The values the siteattribute element and $site.attr render. These are not in any file or theme. Attributes a template declares but nothing has set are included with the template's default, so the response describes what the templates can render rather than only what has been saved. Credentials stored as site attributes are never included.
10480
10538
  # @param storefront_oid [Integer]
@@ -11996,64 +12054,6 @@ module UltracartClient
11996
12054
  return data, status_code, headers
11997
12055
  end
11998
12056
 
11999
- # Who this token is
12000
- # Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
12001
- # @param [Hash] opts the optional parameters
12002
- # @return [SfvbWhoamiResponse]
12003
- def get_sfvb_whoami(opts = {})
12004
- data, _status_code, _headers = get_sfvb_whoami_with_http_info(opts)
12005
- data
12006
- end
12007
-
12008
- # Who this token is
12009
- # Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
12010
- # @param [Hash] opts the optional parameters
12011
- # @return [Array<(SfvbWhoamiResponse, Integer, Hash)>] SfvbWhoamiResponse data, response status code and response headers
12012
- def get_sfvb_whoami_with_http_info(opts = {})
12013
- if @api_client.config.debugging
12014
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_whoami ...'
12015
- end
12016
- # resource path
12017
- local_var_path = '/sfvb/whoami'
12018
-
12019
- # query parameters
12020
- query_params = opts[:query_params] || {}
12021
-
12022
- # header parameters
12023
- header_params = opts[:header_params] || {}
12024
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
12025
- # HTTP header 'Accept' (if needed)
12026
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12027
-
12028
- # form parameters
12029
- form_params = opts[:form_params] || {}
12030
-
12031
- # http body (model)
12032
- post_body = opts[:debug_body]
12033
-
12034
- # return_type
12035
- return_type = opts[:debug_return_type] || 'SfvbWhoamiResponse'
12036
-
12037
- # auth_names
12038
- auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
12039
-
12040
- new_options = opts.merge(
12041
- :operation => :"SfvbApi.get_sfvb_whoami",
12042
- :header_params => header_params,
12043
- :query_params => query_params,
12044
- :form_params => form_params,
12045
- :body => post_body,
12046
- :auth_names => auth_names,
12047
- :return_type => return_type
12048
- )
12049
-
12050
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
12051
- if @api_client.config.debugging
12052
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_whoami\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12053
- end
12054
- return data, status_code, headers
12055
- end
12056
-
12057
12057
  # Ignore a 404 path
12058
12058
  # Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
12059
12059
  # @param storefront_oid [Integer]
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.255'
14
+ VERSION = '4.1.256'
15
15
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.255
4
+ version: 4.1.256
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart