ultracart_api 4.1.235 → 4.1.237

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: ac32f76433609048c8b0555c699ae2dba08997e7f823c82fe1aa05e8c7c6211e
4
- data.tar.gz: a6229e20f7b613674841e39972457e794eb0e0d1b691ddc5119fe5d9c5224d3c
3
+ metadata.gz: 1944e8d81ec56733dccd6d9c0a47f74df20d0e52abb795379978ab6f3f6f9d46
4
+ data.tar.gz: 89b99fc43087349a641c0515c1a233e3f12ae5181873e581ffce0cbd9e32855b
5
5
  SHA512:
6
- metadata.gz: f67c0a2840d6d0e993d1e51e658897b5d6e9e2ec1df38a0d209006813c05ac45f0a200f2d109da7a052528f256df81541a4518c7e51efb93bfac347b67d09774
7
- data.tar.gz: f29f3f76421ce59f0cb1a437666976ac9432ee64f117f4b2da56e14dcd0d0384ca8912c13be082de5a400ad2fcb72b2add2c6242bad5265f32340425ea814071
6
+ metadata.gz: cfe62d59889fa6ea17d7f428cfc63badeecbcdbc49b12c0f7b225f214f74a49be57a78f1603e744364d12ddf254e8623d4e75859c8ee91e5fa5bb885f8e40c22
7
+ data.tar.gz: d093db4c9fad031157248b323d00b6b378c8fd9fd571789a55ac86325caa5eeb1b55ca6bf6606d64e058f25c5a4abf70ec082c09089e661c2001080416b82eb9
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.235
10
+ - Package version: 4.1.237
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.235'
19
+ gem 'ultracart_api', '4.1.237'
20
20
  ```
21
21
 
22
22
  install:
@@ -570,6 +570,7 @@ Class | Method | HTTP request | Description
570
570
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_unreferenced**](docs/SfvbApi.md#get_sfvb_comms_unreferenced) | **GET** /sfvb/storefronts/{storefront_oid}/comms/unreferenced | List the emails and postcards on a storefront that no step names
571
571
  *UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
572
572
  *UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry
573
+ *UltracartClient::SfvbApi* | [**get_sfvb_docs_gap**](docs/SfvbApi.md#get_sfvb_docs_gap) | **GET** /sfvb/docs/gaps/{report_id} | Get a documentation-gap report's status
573
574
  *UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
574
575
  *UltracartClient::SfvbApi* | [**get_sfvb_email**](docs/SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text
575
576
  *UltracartClient::SfvbApi* | [**get_sfvb_events**](docs/SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events
@@ -649,6 +650,7 @@ Class | Method | HTTP request | Description
649
650
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
650
651
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_sending_domain**](docs/SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain
651
652
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
653
+ *UltracartClient::SfvbApi* | [**insert_sfvb_docs_gap**](docs/SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report
652
654
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
653
655
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
654
656
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
@@ -2086,6 +2088,9 @@ Class | Method | HTTP request | Description
2086
2088
  - [UltracartClient::SfvbContainerVersion](docs/SfvbContainerVersion.md)
2087
2089
  - [UltracartClient::SfvbContainerVersionsResponse](docs/SfvbContainerVersionsResponse.md)
2088
2090
  - [UltracartClient::SfvbContainerWriteRequest](docs/SfvbContainerWriteRequest.md)
2091
+ - [UltracartClient::SfvbDocsGap](docs/SfvbDocsGap.md)
2092
+ - [UltracartClient::SfvbDocsGapReport](docs/SfvbDocsGapReport.md)
2093
+ - [UltracartClient::SfvbDocsGapReportGap](docs/SfvbDocsGapReportGap.md)
2089
2094
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
2090
2095
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
2091
2096
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
@@ -2540,6 +2545,8 @@ Not every change is committed to every SDK.
2540
2545
 
2541
2546
  | Version | Date | Comments |
2542
2547
  | --: | :-: | --- |
2548
+ | 4.1.237 | 11/10/2026 | sfvb internal testing |
2549
+ | 4.1.236 | 11/09/2026 | sfvb internal testing |
2543
2550
  | 4.1.235 | 11/09/2026 | sfvb internal testing |
2544
2551
  | 4.1.234 | 11/09/2026 | sfvb internal testing |
2545
2552
  | 4.1.233 | 11/06/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -98,6 +98,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
98
98
  | [**get_sfvb_comms_unreferenced**](SfvbApi.md#get_sfvb_comms_unreferenced) | **GET** /sfvb/storefronts/{storefront_oid}/comms/unreferenced | List the emails and postcards on a storefront that no step names |
99
99
  | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
100
100
  | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
101
+ | [**get_sfvb_docs_gap**](SfvbApi.md#get_sfvb_docs_gap) | **GET** /sfvb/docs/gaps/{report_id} | Get a documentation-gap report's status |
101
102
  | [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
102
103
  | [**get_sfvb_email**](SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text |
103
104
  | [**get_sfvb_events**](SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events |
@@ -177,6 +178,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
177
178
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
178
179
  | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
179
180
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
181
+ | [**insert_sfvb_docs_gap**](SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report |
180
182
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
181
183
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
182
184
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
@@ -5406,6 +5408,59 @@ end
5406
5408
  - **Accept**: application/json
5407
5409
 
5408
5410
 
5411
+ ## get_sfvb_docs_gap
5412
+
5413
+ > <SfvbDocsGap> get_sfvb_docs_gap(report_id)
5414
+
5415
+ Get a documentation-gap report's status
5416
+
5417
+ The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart's internal notes are not returned. A report from another account answers 404.
5418
+
5419
+
5420
+ ### Examples
5421
+
5422
+
5423
+ (No example for this operation).
5424
+
5425
+
5426
+ #### Using the get_sfvb_docs_gap_with_http_info variant
5427
+
5428
+ This returns an Array which contains the response data, status code and headers.
5429
+
5430
+ > <Array(<SfvbDocsGap>, Integer, Hash)> get_sfvb_docs_gap_with_http_info(report_id)
5431
+
5432
+ ```ruby
5433
+ begin
5434
+ # Get a documentation-gap report's status
5435
+ data, status_code, headers = api_instance.get_sfvb_docs_gap_with_http_info(report_id)
5436
+ p status_code # => 2xx
5437
+ p headers # => { ... }
5438
+ p data # => <SfvbDocsGap>
5439
+ rescue UltracartClient::ApiError => e
5440
+ puts "Error when calling SfvbApi->get_sfvb_docs_gap_with_http_info: #{e}"
5441
+ end
5442
+ ```
5443
+
5444
+ ### Parameters
5445
+
5446
+ | Name | Type | Description | Notes |
5447
+ | ---- | ---- | ----------- | ----- |
5448
+ | **report_id** | **String** | | |
5449
+
5450
+ ### Return type
5451
+
5452
+ [**SfvbDocsGap**](SfvbDocsGap.md)
5453
+
5454
+ ### Authorization
5455
+
5456
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5457
+
5458
+ ### HTTP request headers
5459
+
5460
+ - **Content-Type**: Not defined
5461
+ - **Accept**: application/json
5462
+
5463
+
5409
5464
  ## get_sfvb_element
5410
5465
 
5411
5466
  > <SfvbElementSchemaResponse> get_sfvb_element(element_type)
@@ -9684,6 +9739,60 @@ end
9684
9739
  - **Accept**: application/json
9685
9740
 
9686
9741
 
9742
+ ## insert_sfvb_docs_gap
9743
+
9744
+ > <SfvbDocsGap> insert_sfvb_docs_gap(docs_gap_report, opts)
9745
+
9746
+ Send UltraCart a documentation-gap report
9747
+
9748
+ Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
9749
+
9750
+
9751
+ ### Examples
9752
+
9753
+
9754
+ (No example for this operation).
9755
+
9756
+
9757
+ #### Using the insert_sfvb_docs_gap_with_http_info variant
9758
+
9759
+ This returns an Array which contains the response data, status code and headers.
9760
+
9761
+ > <Array(<SfvbDocsGap>, Integer, Hash)> insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
9762
+
9763
+ ```ruby
9764
+ begin
9765
+ # Send UltraCart a documentation-gap report
9766
+ data, status_code, headers = api_instance.insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
9767
+ p status_code # => 2xx
9768
+ p headers # => { ... }
9769
+ p data # => <SfvbDocsGap>
9770
+ rescue UltracartClient::ApiError => e
9771
+ puts "Error when calling SfvbApi->insert_sfvb_docs_gap_with_http_info: #{e}"
9772
+ end
9773
+ ```
9774
+
9775
+ ### Parameters
9776
+
9777
+ | Name | Type | Description | Notes |
9778
+ | ---- | ---- | ----------- | ----- |
9779
+ | **docs_gap_report** | [**SfvbDocsGapReport**](SfvbDocsGapReport.md) | The report | |
9780
+ | **storefront_oid** | **Integer** | The storefront the agent was working on, recorded for context. Leave it out when none applies. | [optional] |
9781
+
9782
+ ### Return type
9783
+
9784
+ [**SfvbDocsGap**](SfvbDocsGap.md)
9785
+
9786
+ ### Authorization
9787
+
9788
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9789
+
9790
+ ### HTTP request headers
9791
+
9792
+ - **Content-Type**: application/json; charset=UTF-8
9793
+ - **Accept**: application/json
9794
+
9795
+
9687
9796
  ## insert_sfvb_page
9688
9797
 
9689
9798
  > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbDocsGap
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **duplicate** | **Boolean** | On submit, true when this account had already sent the same report. The earlier report_id is returned and nothing new is kept. | [optional] |
8
+ | **received_at** | **String** | When UltraCart received the report. | [optional] |
9
+ | **report_id** | **String** | The report&#39;s id. Quote it to UltraCart, or look the report up with GET docs/gaps/{report_id}. | [optional] |
10
+ | **status** | **String** | received until UltraCart staff look at it, then accepted, declined or fixed. | [optional] |
11
+ | **status_at** | **String** | When the status last changed. Absent while the report is received. | [optional] |
12
+ | **storefront_oid** | **Integer** | The storefront named when the report was sent, if one was. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbDocsGap.new(
20
+ duplicate: null,
21
+ received_at: null,
22
+ report_id: null,
23
+ status: null,
24
+ status_at: null,
25
+ storefront_oid: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbDocsGapReport
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **String** | When the report was captured, as a UTC ISO-8601 timestamp. Not more than a day ahead of the server&#39;s clock. | [optional] |
8
+ | **format_version** | **Integer** | Always 1. | [optional] |
9
+ | **gap** | [**SfvbDocsGapReportGap**](SfvbDocsGapReportGap.md) | | [optional] |
10
+ | **kind** | **String** | Always documentation-gap. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbDocsGapReport.new(
18
+ created_at: null,
19
+ format_version: null,
20
+ gap: null,
21
+ kind: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::SfvbDocsGapReportGap
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **documentation_url** | **String** | The nearest documentation page, an absolute http or https URL of at most 2000 characters. Leave it out when no page exists. | [optional] |
8
+ | **evidence** | **Array&lt;String&gt;** | 1 to 20 sanitized evidence descriptions or links, each at most 8000 characters. | [optional] |
9
+ | **expected** | **String** | What the documentation should say, at most 8000 characters. | [optional] |
10
+ | **observed** | **String** | The confirmed behavior, or the guidance that is missing, at most 8000 characters. | [optional] |
11
+ | **title** | **String** | A short description of the gap, at most 200 characters. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::SfvbDocsGapReportGap.new(
19
+ documentation_url: null,
20
+ evidence: null,
21
+ expected: null,
22
+ observed: null,
23
+ title: null
24
+ )
25
+ ```
26
+
@@ -18,7 +18,7 @@
18
18
  | **hash_sha256** | **String** | The hash of the stored settings. A secret counts by its mask and length only. Send it as If-Match when changing or clearing the provider. | [optional] |
19
19
  | **key** | **String** | The provider key, such as facebook or google_analytics. | [optional] |
20
20
  | **name** | **String** | The name the admin shows. | [optional] |
21
- | **notes** | **Array&lt;String&gt;** | Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin. | [optional] |
21
+ | **notes** | **Array&lt;String&gt;** | Anything for a person to know or do, such as a field the provider needs before it sends anything, or an OAuth connection to disconnect in the admin after a write. | [optional] |
22
22
  | **oauth** | [**SfvbTrackingProviderOauth**](SfvbTrackingProviderOauth.md) | | [optional] |
23
23
  | **server_side** | **String** | What the provider also sends from UltraCart&#39;s servers. A consent gate holds back only the browser pixel, not these. Absent when it sends nothing server side. | [optional] |
24
24
  | **wholesale_tiers** | [**Array&lt;SfvbTrackingWholesaleTier&gt;**](SfvbTrackingWholesaleTier.md) | For google_analytics, the account number per wholesale pricing tier. | [optional] |
@@ -6854,6 +6854,70 @@ module UltracartClient
6854
6854
  return data, status_code, headers
6855
6855
  end
6856
6856
 
6857
+ # Get a documentation-gap report's status
6858
+ # The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart's internal notes are not returned. A report from another account answers 404.
6859
+ # @param report_id [String]
6860
+ # @param [Hash] opts the optional parameters
6861
+ # @return [SfvbDocsGap]
6862
+ def get_sfvb_docs_gap(report_id, opts = {})
6863
+ data, _status_code, _headers = get_sfvb_docs_gap_with_http_info(report_id, opts)
6864
+ data
6865
+ end
6866
+
6867
+ # Get a documentation-gap report&#39;s status
6868
+ # The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart&#39;s internal notes are not returned. A report from another account answers 404.
6869
+ # @param report_id [String]
6870
+ # @param [Hash] opts the optional parameters
6871
+ # @return [Array<(SfvbDocsGap, Integer, Hash)>] SfvbDocsGap data, response status code and response headers
6872
+ def get_sfvb_docs_gap_with_http_info(report_id, opts = {})
6873
+ if @api_client.config.debugging
6874
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_docs_gap ...'
6875
+ end
6876
+ # verify the required parameter 'report_id' is set
6877
+ if @api_client.config.client_side_validation && report_id.nil?
6878
+ fail ArgumentError, "Missing the required parameter 'report_id' when calling SfvbApi.get_sfvb_docs_gap"
6879
+ end
6880
+ # resource path
6881
+ local_var_path = '/sfvb/docs/gaps/{report_id}'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
6882
+
6883
+ # query parameters
6884
+ query_params = opts[:query_params] || {}
6885
+
6886
+ # header parameters
6887
+ header_params = opts[:header_params] || {}
6888
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6889
+ # HTTP header 'Accept' (if needed)
6890
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6891
+
6892
+ # form parameters
6893
+ form_params = opts[:form_params] || {}
6894
+
6895
+ # http body (model)
6896
+ post_body = opts[:debug_body]
6897
+
6898
+ # return_type
6899
+ return_type = opts[:debug_return_type] || 'SfvbDocsGap'
6900
+
6901
+ # auth_names
6902
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6903
+
6904
+ new_options = opts.merge(
6905
+ :operation => :"SfvbApi.get_sfvb_docs_gap",
6906
+ :header_params => header_params,
6907
+ :query_params => query_params,
6908
+ :form_params => form_params,
6909
+ :body => post_body,
6910
+ :auth_names => auth_names,
6911
+ :return_type => return_type
6912
+ )
6913
+
6914
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6915
+ if @api_client.config.debugging
6916
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_docs_gap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6917
+ end
6918
+ return data, status_code, headers
6919
+ end
6920
+
6857
6921
  # Configuration schema and field card for one element type
6858
6922
  # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
6859
6923
  # @param element_type [String]
@@ -12382,6 +12446,78 @@ module UltracartClient
12382
12446
  return data, status_code, headers
12383
12447
  end
12384
12448
 
12449
+ # Send UltraCart a documentation-gap report
12450
+ # Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
12451
+ # @param docs_gap_report [SfvbDocsGapReport] The report
12452
+ # @param [Hash] opts the optional parameters
12453
+ # @option opts [Integer] :storefront_oid The storefront the agent was working on, recorded for context. Leave it out when none applies.
12454
+ # @return [SfvbDocsGap]
12455
+ def insert_sfvb_docs_gap(docs_gap_report, opts = {})
12456
+ data, _status_code, _headers = insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
12457
+ data
12458
+ end
12459
+
12460
+ # Send UltraCart a documentation-gap report
12461
+ # Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
12462
+ # @param docs_gap_report [SfvbDocsGapReport] The report
12463
+ # @param [Hash] opts the optional parameters
12464
+ # @option opts [Integer] :storefront_oid The storefront the agent was working on, recorded for context. Leave it out when none applies.
12465
+ # @return [Array<(SfvbDocsGap, Integer, Hash)>] SfvbDocsGap data, response status code and response headers
12466
+ def insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts = {})
12467
+ if @api_client.config.debugging
12468
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_docs_gap ...'
12469
+ end
12470
+ # verify the required parameter 'docs_gap_report' is set
12471
+ if @api_client.config.client_side_validation && docs_gap_report.nil?
12472
+ fail ArgumentError, "Missing the required parameter 'docs_gap_report' when calling SfvbApi.insert_sfvb_docs_gap"
12473
+ end
12474
+ # resource path
12475
+ local_var_path = '/sfvb/docs/gaps'
12476
+
12477
+ # query parameters
12478
+ query_params = opts[:query_params] || {}
12479
+ query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
12480
+
12481
+ # header parameters
12482
+ header_params = opts[:header_params] || {}
12483
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
12484
+ # HTTP header 'Accept' (if needed)
12485
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12486
+ # HTTP header 'Content-Type'
12487
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
12488
+ if !content_type.nil?
12489
+ header_params['Content-Type'] = content_type
12490
+ end
12491
+
12492
+ # form parameters
12493
+ form_params = opts[:form_params] || {}
12494
+
12495
+ # http body (model)
12496
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(docs_gap_report)
12497
+
12498
+ # return_type
12499
+ return_type = opts[:debug_return_type] || 'SfvbDocsGap'
12500
+
12501
+ # auth_names
12502
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
12503
+
12504
+ new_options = opts.merge(
12505
+ :operation => :"SfvbApi.insert_sfvb_docs_gap",
12506
+ :header_params => header_params,
12507
+ :query_params => query_params,
12508
+ :form_params => form_params,
12509
+ :body => post_body,
12510
+ :auth_names => auth_names,
12511
+ :return_type => return_type
12512
+ )
12513
+
12514
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12515
+ if @api_client.config.debugging
12516
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_docs_gap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12517
+ end
12518
+ return data, status_code, headers
12519
+ end
12520
+
12385
12521
  # Create a page
12386
12522
  # 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.
12387
12523
  # @param storefront_oid [Integer]
@@ -239,7 +239,7 @@ module UltracartClient
239
239
  # Check to see if the all the properties in the model are valid
240
240
  # @return true if the model is valid
241
241
  def valid?
242
- action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "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_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"])
242
+ action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "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"])
243
243
  return false unless action_validator.valid?(@action)
244
244
  true
245
245
  end
@@ -247,7 +247,7 @@ module UltracartClient
247
247
  # Custom attribute writer method checking allowed values (enum).
248
248
  # @param [Object] action Object to be assigned
249
249
  def action=(action)
250
- validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "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_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"])
250
+ validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "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"])
251
251
  unless validator.valid?(action)
252
252
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
253
253
  end
@@ -0,0 +1,304 @@
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 SfvbDocsGap
18
+ # On submit, true when this account had already sent the same report. The earlier report_id is returned and nothing new is kept.
19
+ attr_accessor :duplicate
20
+
21
+ # When UltraCart received the report.
22
+ attr_accessor :received_at
23
+
24
+ # The report's id. Quote it to UltraCart, or look the report up with GET docs/gaps/{report_id}.
25
+ attr_accessor :report_id
26
+
27
+ # received until UltraCart staff look at it, then accepted, declined or fixed.
28
+ attr_accessor :status
29
+
30
+ # When the status last changed. Absent while the report is received.
31
+ attr_accessor :status_at
32
+
33
+ # The storefront named when the report was sent, if one was.
34
+ attr_accessor :storefront_oid
35
+
36
+ class EnumAttributeValidator
37
+ attr_reader :datatype
38
+ attr_reader :allowable_values
39
+
40
+ def initialize(datatype, allowable_values)
41
+ @allowable_values = allowable_values.map do |value|
42
+ case datatype.to_s
43
+ when /Integer/i
44
+ value.to_i
45
+ when /Float/i
46
+ value.to_f
47
+ else
48
+ value
49
+ end
50
+ end
51
+ end
52
+
53
+ def valid?(value)
54
+ !value || allowable_values.include?(value)
55
+ end
56
+ end
57
+
58
+ # Attribute mapping from ruby-style variable name to JSON key.
59
+ def self.attribute_map
60
+ {
61
+ :'duplicate' => :'duplicate',
62
+ :'received_at' => :'received_at',
63
+ :'report_id' => :'report_id',
64
+ :'status' => :'status',
65
+ :'status_at' => :'status_at',
66
+ :'storefront_oid' => :'storefront_oid'
67
+ }
68
+ end
69
+
70
+ # Returns all the JSON keys this model knows about
71
+ def self.acceptable_attributes
72
+ attribute_map.values
73
+ end
74
+
75
+ # Attribute type mapping.
76
+ def self.openapi_types
77
+ {
78
+ :'duplicate' => :'Boolean',
79
+ :'received_at' => :'String',
80
+ :'report_id' => :'String',
81
+ :'status' => :'String',
82
+ :'status_at' => :'String',
83
+ :'storefront_oid' => :'Integer'
84
+ }
85
+ end
86
+
87
+ # List of attributes with nullable: true
88
+ def self.openapi_nullable
89
+ Set.new([
90
+ ])
91
+ end
92
+
93
+ # Initializes the object
94
+ # @param [Hash] attributes Model attributes in the form of hash
95
+ def initialize(attributes = {})
96
+ if (!attributes.is_a?(Hash))
97
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbDocsGap` initialize method"
98
+ end
99
+
100
+ # check to see if the attribute exists and convert string to symbol for hash key
101
+ attributes = attributes.each_with_object({}) { |(k, v), h|
102
+ if (!self.class.attribute_map.key?(k.to_sym))
103
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbDocsGap`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
104
+ end
105
+ h[k.to_sym] = v
106
+ }
107
+
108
+ if attributes.key?(:'duplicate')
109
+ self.duplicate = attributes[:'duplicate']
110
+ end
111
+
112
+ if attributes.key?(:'received_at')
113
+ self.received_at = attributes[:'received_at']
114
+ end
115
+
116
+ if attributes.key?(:'report_id')
117
+ self.report_id = attributes[:'report_id']
118
+ end
119
+
120
+ if attributes.key?(:'status')
121
+ self.status = attributes[:'status']
122
+ end
123
+
124
+ if attributes.key?(:'status_at')
125
+ self.status_at = attributes[:'status_at']
126
+ end
127
+
128
+ if attributes.key?(:'storefront_oid')
129
+ self.storefront_oid = attributes[:'storefront_oid']
130
+ end
131
+ end
132
+
133
+ # Show invalid properties with the reasons. Usually used together with valid?
134
+ # @return Array for valid properties with the reasons
135
+ def list_invalid_properties
136
+ invalid_properties = Array.new
137
+ invalid_properties
138
+ end
139
+
140
+ # Check to see if the all the properties in the model are valid
141
+ # @return true if the model is valid
142
+ def valid?
143
+ status_validator = EnumAttributeValidator.new('String', ["received", "accepted", "declined", "fixed"])
144
+ return false unless status_validator.valid?(@status)
145
+ true
146
+ end
147
+
148
+ # Custom attribute writer method checking allowed values (enum).
149
+ # @param [Object] status Object to be assigned
150
+ def status=(status)
151
+ validator = EnumAttributeValidator.new('String', ["received", "accepted", "declined", "fixed"])
152
+ unless validator.valid?(status)
153
+ fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
154
+ end
155
+ @status = status
156
+ end
157
+
158
+ # Checks equality by comparing each attribute.
159
+ # @param [Object] Object to be compared
160
+ def ==(o)
161
+ return true if self.equal?(o)
162
+ self.class == o.class &&
163
+ duplicate == o.duplicate &&
164
+ received_at == o.received_at &&
165
+ report_id == o.report_id &&
166
+ status == o.status &&
167
+ status_at == o.status_at &&
168
+ storefront_oid == o.storefront_oid
169
+ end
170
+
171
+ # @see the `==` method
172
+ # @param [Object] Object to be compared
173
+ def eql?(o)
174
+ self == o
175
+ end
176
+
177
+ # Calculates hash code according to all attributes.
178
+ # @return [Integer] Hash code
179
+ def hash
180
+ [duplicate, received_at, report_id, status, status_at, storefront_oid].hash
181
+ end
182
+
183
+ # Builds the object from hash
184
+ # @param [Hash] attributes Model attributes in the form of hash
185
+ # @return [Object] Returns the model itself
186
+ def self.build_from_hash(attributes)
187
+ new.build_from_hash(attributes)
188
+ end
189
+
190
+ # Builds the object from hash
191
+ # @param [Hash] attributes Model attributes in the form of hash
192
+ # @return [Object] Returns the model itself
193
+ def build_from_hash(attributes)
194
+ return nil unless attributes.is_a?(Hash)
195
+ attributes = attributes.transform_keys(&:to_sym)
196
+ self.class.openapi_types.each_pair do |key, type|
197
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
198
+ self.send("#{key}=", nil)
199
+ elsif type =~ /\AArray<(.*)>/i
200
+ # check to ensure the input is an array given that the attribute
201
+ # is documented as an array but the input is not
202
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
203
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
204
+ end
205
+ elsif !attributes[self.class.attribute_map[key]].nil?
206
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
207
+ end
208
+ end
209
+
210
+ self
211
+ end
212
+
213
+ # Deserializes the data based on type
214
+ # @param string type Data type
215
+ # @param string value Value to be deserialized
216
+ # @return [Object] Deserialized data
217
+ def _deserialize(type, value)
218
+ case type.to_sym
219
+ when :Time
220
+ Time.parse(value)
221
+ when :Date
222
+ Date.parse(value)
223
+ when :String
224
+ value.to_s
225
+ when :Integer
226
+ value.to_i
227
+ when :Float
228
+ value.to_f
229
+ when :Boolean
230
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
231
+ true
232
+ else
233
+ false
234
+ end
235
+ when :Object
236
+ # generic object (usually a Hash), return directly
237
+ value
238
+ when /\AArray<(?<inner_type>.+)>\z/
239
+ inner_type = Regexp.last_match[:inner_type]
240
+ value.map { |v| _deserialize(inner_type, v) }
241
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
242
+ k_type = Regexp.last_match[:k_type]
243
+ v_type = Regexp.last_match[:v_type]
244
+ {}.tap do |hash|
245
+ value.each do |k, v|
246
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
247
+ end
248
+ end
249
+ else # model
250
+ # models (e.g. Pet) or oneOf
251
+ klass = UltracartClient.const_get(type)
252
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
253
+ end
254
+ end
255
+
256
+ # Returns the string representation of the object
257
+ # @return [String] String presentation of the object
258
+ def to_s
259
+ to_hash.to_s
260
+ end
261
+
262
+ # to_body is an alias to to_hash (backward compatibility)
263
+ # @return [Hash] Returns the object in the form of hash
264
+ def to_body
265
+ to_hash
266
+ end
267
+
268
+ # Returns the object in the form of hash
269
+ # @return [Hash] Returns the object in the form of hash
270
+ def to_hash
271
+ hash = {}
272
+ self.class.attribute_map.each_pair do |attr, param|
273
+ value = self.send(attr)
274
+ if value.nil?
275
+ is_nullable = self.class.openapi_nullable.include?(attr)
276
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
277
+ end
278
+
279
+ hash[param] = _to_hash(value)
280
+ end
281
+ hash
282
+ end
283
+
284
+ # Outputs non-array value in the form of hash
285
+ # For object, use to_hash. Otherwise, just return the value
286
+ # @param [Object] value Any valid value
287
+ # @return [Hash] Returns the value in the form of hash
288
+ def _to_hash(value)
289
+ if value.is_a?(Array)
290
+ value.compact.map { |v| _to_hash(v) }
291
+ elsif value.is_a?(Hash)
292
+ {}.tap do |hash|
293
+ value.each { |k, v| hash[k] = _to_hash(v) }
294
+ end
295
+ elsif value.respond_to? :to_hash
296
+ value.to_hash
297
+ else
298
+ value
299
+ end
300
+ end
301
+
302
+ end
303
+
304
+ end
@@ -0,0 +1,249 @@
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 SfvbDocsGapReport
18
+ # When the report was captured, as a UTC ISO-8601 timestamp. Not more than a day ahead of the server's clock.
19
+ attr_accessor :created_at
20
+
21
+ # Always 1.
22
+ attr_accessor :format_version
23
+
24
+ attr_accessor :gap
25
+
26
+ # Always documentation-gap.
27
+ attr_accessor :kind
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'created_at' => :'created_at',
33
+ :'format_version' => :'format_version',
34
+ :'gap' => :'gap',
35
+ :'kind' => :'kind'
36
+ }
37
+ end
38
+
39
+ # Returns all the JSON keys this model knows about
40
+ def self.acceptable_attributes
41
+ attribute_map.values
42
+ end
43
+
44
+ # Attribute type mapping.
45
+ def self.openapi_types
46
+ {
47
+ :'created_at' => :'String',
48
+ :'format_version' => :'Integer',
49
+ :'gap' => :'SfvbDocsGapReportGap',
50
+ :'kind' => :'String'
51
+ }
52
+ end
53
+
54
+ # List of attributes with nullable: true
55
+ def self.openapi_nullable
56
+ Set.new([
57
+ ])
58
+ end
59
+
60
+ # Initializes the object
61
+ # @param [Hash] attributes Model attributes in the form of hash
62
+ def initialize(attributes = {})
63
+ if (!attributes.is_a?(Hash))
64
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbDocsGapReport` initialize method"
65
+ end
66
+
67
+ # check to see if the attribute exists and convert string to symbol for hash key
68
+ attributes = attributes.each_with_object({}) { |(k, v), h|
69
+ if (!self.class.attribute_map.key?(k.to_sym))
70
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbDocsGapReport`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
71
+ end
72
+ h[k.to_sym] = v
73
+ }
74
+
75
+ if attributes.key?(:'created_at')
76
+ self.created_at = attributes[:'created_at']
77
+ end
78
+
79
+ if attributes.key?(:'format_version')
80
+ self.format_version = attributes[:'format_version']
81
+ end
82
+
83
+ if attributes.key?(:'gap')
84
+ self.gap = attributes[:'gap']
85
+ end
86
+
87
+ if attributes.key?(:'kind')
88
+ self.kind = attributes[:'kind']
89
+ end
90
+ end
91
+
92
+ # Show invalid properties with the reasons. Usually used together with valid?
93
+ # @return Array for valid properties with the reasons
94
+ def list_invalid_properties
95
+ invalid_properties = Array.new
96
+ invalid_properties
97
+ end
98
+
99
+ # Check to see if the all the properties in the model are valid
100
+ # @return true if the model is valid
101
+ def valid?
102
+ true
103
+ end
104
+
105
+ # Checks equality by comparing each attribute.
106
+ # @param [Object] Object to be compared
107
+ def ==(o)
108
+ return true if self.equal?(o)
109
+ self.class == o.class &&
110
+ created_at == o.created_at &&
111
+ format_version == o.format_version &&
112
+ gap == o.gap &&
113
+ kind == o.kind
114
+ end
115
+
116
+ # @see the `==` method
117
+ # @param [Object] Object to be compared
118
+ def eql?(o)
119
+ self == o
120
+ end
121
+
122
+ # Calculates hash code according to all attributes.
123
+ # @return [Integer] Hash code
124
+ def hash
125
+ [created_at, format_version, gap, kind].hash
126
+ end
127
+
128
+ # Builds the object from hash
129
+ # @param [Hash] attributes Model attributes in the form of hash
130
+ # @return [Object] Returns the model itself
131
+ def self.build_from_hash(attributes)
132
+ new.build_from_hash(attributes)
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ self.class.openapi_types.each_pair do |key, type|
142
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
143
+ self.send("#{key}=", nil)
144
+ elsif type =~ /\AArray<(.*)>/i
145
+ # check to ensure the input is an array given that the attribute
146
+ # is documented as an array but the input is not
147
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
148
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
149
+ end
150
+ elsif !attributes[self.class.attribute_map[key]].nil?
151
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
152
+ end
153
+ end
154
+
155
+ self
156
+ end
157
+
158
+ # Deserializes the data based on type
159
+ # @param string type Data type
160
+ # @param string value Value to be deserialized
161
+ # @return [Object] Deserialized data
162
+ def _deserialize(type, value)
163
+ case type.to_sym
164
+ when :Time
165
+ Time.parse(value)
166
+ when :Date
167
+ Date.parse(value)
168
+ when :String
169
+ value.to_s
170
+ when :Integer
171
+ value.to_i
172
+ when :Float
173
+ value.to_f
174
+ when :Boolean
175
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
176
+ true
177
+ else
178
+ false
179
+ end
180
+ when :Object
181
+ # generic object (usually a Hash), return directly
182
+ value
183
+ when /\AArray<(?<inner_type>.+)>\z/
184
+ inner_type = Regexp.last_match[:inner_type]
185
+ value.map { |v| _deserialize(inner_type, v) }
186
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
187
+ k_type = Regexp.last_match[:k_type]
188
+ v_type = Regexp.last_match[:v_type]
189
+ {}.tap do |hash|
190
+ value.each do |k, v|
191
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
192
+ end
193
+ end
194
+ else # model
195
+ # models (e.g. Pet) or oneOf
196
+ klass = UltracartClient.const_get(type)
197
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
198
+ end
199
+ end
200
+
201
+ # Returns the string representation of the object
202
+ # @return [String] String presentation of the object
203
+ def to_s
204
+ to_hash.to_s
205
+ end
206
+
207
+ # to_body is an alias to to_hash (backward compatibility)
208
+ # @return [Hash] Returns the object in the form of hash
209
+ def to_body
210
+ to_hash
211
+ end
212
+
213
+ # Returns the object in the form of hash
214
+ # @return [Hash] Returns the object in the form of hash
215
+ def to_hash
216
+ hash = {}
217
+ self.class.attribute_map.each_pair do |attr, param|
218
+ value = self.send(attr)
219
+ if value.nil?
220
+ is_nullable = self.class.openapi_nullable.include?(attr)
221
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
222
+ end
223
+
224
+ hash[param] = _to_hash(value)
225
+ end
226
+ hash
227
+ end
228
+
229
+ # Outputs non-array value in the form of hash
230
+ # For object, use to_hash. Otherwise, just return the value
231
+ # @param [Object] value Any valid value
232
+ # @return [Hash] Returns the value in the form of hash
233
+ def _to_hash(value)
234
+ if value.is_a?(Array)
235
+ value.compact.map { |v| _to_hash(v) }
236
+ elsif value.is_a?(Hash)
237
+ {}.tap do |hash|
238
+ value.each { |k, v| hash[k] = _to_hash(v) }
239
+ end
240
+ elsif value.respond_to? :to_hash
241
+ value.to_hash
242
+ else
243
+ value
244
+ end
245
+ end
246
+
247
+ end
248
+
249
+ end
@@ -0,0 +1,262 @@
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 SfvbDocsGapReportGap
18
+ # The nearest documentation page, an absolute http or https URL of at most 2000 characters. Leave it out when no page exists.
19
+ attr_accessor :documentation_url
20
+
21
+ # 1 to 20 sanitized evidence descriptions or links, each at most 8000 characters.
22
+ attr_accessor :evidence
23
+
24
+ # What the documentation should say, at most 8000 characters.
25
+ attr_accessor :expected
26
+
27
+ # The confirmed behavior, or the guidance that is missing, at most 8000 characters.
28
+ attr_accessor :observed
29
+
30
+ # A short description of the gap, at most 200 characters.
31
+ attr_accessor :title
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'documentation_url' => :'documentation_url',
37
+ :'evidence' => :'evidence',
38
+ :'expected' => :'expected',
39
+ :'observed' => :'observed',
40
+ :'title' => :'title'
41
+ }
42
+ end
43
+
44
+ # Returns all the JSON keys this model knows about
45
+ def self.acceptable_attributes
46
+ attribute_map.values
47
+ end
48
+
49
+ # Attribute type mapping.
50
+ def self.openapi_types
51
+ {
52
+ :'documentation_url' => :'String',
53
+ :'evidence' => :'Array<String>',
54
+ :'expected' => :'String',
55
+ :'observed' => :'String',
56
+ :'title' => :'String'
57
+ }
58
+ end
59
+
60
+ # List of attributes with nullable: true
61
+ def self.openapi_nullable
62
+ Set.new([
63
+ ])
64
+ end
65
+
66
+ # Initializes the object
67
+ # @param [Hash] attributes Model attributes in the form of hash
68
+ def initialize(attributes = {})
69
+ if (!attributes.is_a?(Hash))
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbDocsGapReportGap` initialize method"
71
+ end
72
+
73
+ # check to see if the attribute exists and convert string to symbol for hash key
74
+ attributes = attributes.each_with_object({}) { |(k, v), h|
75
+ if (!self.class.attribute_map.key?(k.to_sym))
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbDocsGapReportGap`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
+ end
78
+ h[k.to_sym] = v
79
+ }
80
+
81
+ if attributes.key?(:'documentation_url')
82
+ self.documentation_url = attributes[:'documentation_url']
83
+ end
84
+
85
+ if attributes.key?(:'evidence')
86
+ if (value = attributes[:'evidence']).is_a?(Array)
87
+ self.evidence = value
88
+ end
89
+ end
90
+
91
+ if attributes.key?(:'expected')
92
+ self.expected = attributes[:'expected']
93
+ end
94
+
95
+ if attributes.key?(:'observed')
96
+ self.observed = attributes[:'observed']
97
+ end
98
+
99
+ if attributes.key?(:'title')
100
+ self.title = attributes[:'title']
101
+ end
102
+ end
103
+
104
+ # Show invalid properties with the reasons. Usually used together with valid?
105
+ # @return Array for valid properties with the reasons
106
+ def list_invalid_properties
107
+ invalid_properties = Array.new
108
+ invalid_properties
109
+ end
110
+
111
+ # Check to see if the all the properties in the model are valid
112
+ # @return true if the model is valid
113
+ def valid?
114
+ true
115
+ end
116
+
117
+ # Checks equality by comparing each attribute.
118
+ # @param [Object] Object to be compared
119
+ def ==(o)
120
+ return true if self.equal?(o)
121
+ self.class == o.class &&
122
+ documentation_url == o.documentation_url &&
123
+ evidence == o.evidence &&
124
+ expected == o.expected &&
125
+ observed == o.observed &&
126
+ title == o.title
127
+ end
128
+
129
+ # @see the `==` method
130
+ # @param [Object] Object to be compared
131
+ def eql?(o)
132
+ self == o
133
+ end
134
+
135
+ # Calculates hash code according to all attributes.
136
+ # @return [Integer] Hash code
137
+ def hash
138
+ [documentation_url, evidence, expected, observed, title].hash
139
+ end
140
+
141
+ # Builds the object from hash
142
+ # @param [Hash] attributes Model attributes in the form of hash
143
+ # @return [Object] Returns the model itself
144
+ def self.build_from_hash(attributes)
145
+ new.build_from_hash(attributes)
146
+ end
147
+
148
+ # Builds the object from hash
149
+ # @param [Hash] attributes Model attributes in the form of hash
150
+ # @return [Object] Returns the model itself
151
+ def build_from_hash(attributes)
152
+ return nil unless attributes.is_a?(Hash)
153
+ attributes = attributes.transform_keys(&:to_sym)
154
+ self.class.openapi_types.each_pair do |key, type|
155
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
156
+ self.send("#{key}=", nil)
157
+ elsif type =~ /\AArray<(.*)>/i
158
+ # check to ensure the input is an array given that the attribute
159
+ # is documented as an array but the input is not
160
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
161
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
162
+ end
163
+ elsif !attributes[self.class.attribute_map[key]].nil?
164
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
165
+ end
166
+ end
167
+
168
+ self
169
+ end
170
+
171
+ # Deserializes the data based on type
172
+ # @param string type Data type
173
+ # @param string value Value to be deserialized
174
+ # @return [Object] Deserialized data
175
+ def _deserialize(type, value)
176
+ case type.to_sym
177
+ when :Time
178
+ Time.parse(value)
179
+ when :Date
180
+ Date.parse(value)
181
+ when :String
182
+ value.to_s
183
+ when :Integer
184
+ value.to_i
185
+ when :Float
186
+ value.to_f
187
+ when :Boolean
188
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
189
+ true
190
+ else
191
+ false
192
+ end
193
+ when :Object
194
+ # generic object (usually a Hash), return directly
195
+ value
196
+ when /\AArray<(?<inner_type>.+)>\z/
197
+ inner_type = Regexp.last_match[:inner_type]
198
+ value.map { |v| _deserialize(inner_type, v) }
199
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
200
+ k_type = Regexp.last_match[:k_type]
201
+ v_type = Regexp.last_match[:v_type]
202
+ {}.tap do |hash|
203
+ value.each do |k, v|
204
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
205
+ end
206
+ end
207
+ else # model
208
+ # models (e.g. Pet) or oneOf
209
+ klass = UltracartClient.const_get(type)
210
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
211
+ end
212
+ end
213
+
214
+ # Returns the string representation of the object
215
+ # @return [String] String presentation of the object
216
+ def to_s
217
+ to_hash.to_s
218
+ end
219
+
220
+ # to_body is an alias to to_hash (backward compatibility)
221
+ # @return [Hash] Returns the object in the form of hash
222
+ def to_body
223
+ to_hash
224
+ end
225
+
226
+ # Returns the object in the form of hash
227
+ # @return [Hash] Returns the object in the form of hash
228
+ def to_hash
229
+ hash = {}
230
+ self.class.attribute_map.each_pair do |attr, param|
231
+ value = self.send(attr)
232
+ if value.nil?
233
+ is_nullable = self.class.openapi_nullable.include?(attr)
234
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
235
+ end
236
+
237
+ hash[param] = _to_hash(value)
238
+ end
239
+ hash
240
+ end
241
+
242
+ # Outputs non-array value in the form of hash
243
+ # For object, use to_hash. Otherwise, just return the value
244
+ # @param [Object] value Any valid value
245
+ # @return [Hash] Returns the value in the form of hash
246
+ def _to_hash(value)
247
+ if value.is_a?(Array)
248
+ value.compact.map { |v| _to_hash(v) }
249
+ elsif value.is_a?(Hash)
250
+ {}.tap do |hash|
251
+ value.each { |k, v| hash[k] = _to_hash(v) }
252
+ end
253
+ elsif value.respond_to? :to_hash
254
+ value.to_hash
255
+ else
256
+ value
257
+ end
258
+ end
259
+
260
+ end
261
+
262
+ end
@@ -56,7 +56,7 @@ module UltracartClient
56
56
  # The name the admin shows.
57
57
  attr_accessor :name
58
58
 
59
- # Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin.
59
+ # Anything for a person to know or do, such as a field the provider needs before it sends anything, or an OAuth connection to disconnect in the admin after a write.
60
60
  attr_accessor :notes
61
61
 
62
62
  attr_accessor :oauth
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.235'
14
+ VERSION = '4.1.237'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -1077,6 +1077,9 @@ require 'ultracart_api/models/sfvb_container_revert_request'
1077
1077
  require 'ultracart_api/models/sfvb_container_version'
1078
1078
  require 'ultracart_api/models/sfvb_container_versions_response'
1079
1079
  require 'ultracart_api/models/sfvb_container_write_request'
1080
+ require 'ultracart_api/models/sfvb_docs_gap'
1081
+ require 'ultracart_api/models/sfvb_docs_gap_report'
1082
+ require 'ultracart_api/models/sfvb_docs_gap_report_gap'
1080
1083
  require 'ultracart_api/models/sfvb_element'
1081
1084
  require 'ultracart_api/models/sfvb_element_schema_response'
1082
1085
  require 'ultracart_api/models/sfvb_elements_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.235
4
+ version: 4.1.237
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-09 00:00:00.000000000 Z
11
+ date: 2026-11-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -1139,6 +1139,9 @@ files:
1139
1139
  - docs/SfvbContainerVersion.md
1140
1140
  - docs/SfvbContainerVersionsResponse.md
1141
1141
  - docs/SfvbContainerWriteRequest.md
1142
+ - docs/SfvbDocsGap.md
1143
+ - docs/SfvbDocsGapReport.md
1144
+ - docs/SfvbDocsGapReportGap.md
1142
1145
  - docs/SfvbElement.md
1143
1146
  - docs/SfvbElementSchemaResponse.md
1144
1147
  - docs/SfvbElementsResponse.md
@@ -2611,6 +2614,9 @@ files:
2611
2614
  - lib/ultracart_api/models/sfvb_container_version.rb
2612
2615
  - lib/ultracart_api/models/sfvb_container_versions_response.rb
2613
2616
  - lib/ultracart_api/models/sfvb_container_write_request.rb
2617
+ - lib/ultracart_api/models/sfvb_docs_gap.rb
2618
+ - lib/ultracart_api/models/sfvb_docs_gap_report.rb
2619
+ - lib/ultracart_api/models/sfvb_docs_gap_report_gap.rb
2614
2620
  - lib/ultracart_api/models/sfvb_element.rb
2615
2621
  - lib/ultracart_api/models/sfvb_element_schema_response.rb
2616
2622
  - lib/ultracart_api/models/sfvb_elements_response.rb