ultracart_api 4.1.236 → 4.1.238

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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -2
  3. data/docs/SfvbApi.md +338 -0
  4. data/docs/SfvbApprovalCreateRequest.md +4 -0
  5. data/docs/SfvbDocsGap.md +28 -0
  6. data/docs/SfvbDocsGapReport.md +24 -0
  7. data/docs/SfvbDocsGapReportGap.md +26 -0
  8. data/docs/SfvbItemPreorder.md +36 -0
  9. data/docs/SfvbItemPreorderChange.md +24 -0
  10. data/docs/SfvbItemPreorderChildRow.md +20 -0
  11. data/docs/SfvbItemPreorderChildrenRequest.md +24 -0
  12. data/docs/SfvbItemPreorderListResponse.md +20 -0
  13. data/docs/SfvbItemPreorderOption.md +20 -0
  14. data/docs/SfvbItemPreorderRequest.md +22 -0
  15. data/docs/SfvbWhoamiResponse.md +4 -0
  16. data/docs/TaxJarConfig.md +2 -0
  17. data/lib/ultracart_api/api/sfvb_api.rb +451 -0
  18. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +21 -3
  19. data/lib/ultracart_api/models/sfvb_docs_gap.rb +304 -0
  20. data/lib/ultracart_api/models/sfvb_docs_gap_report.rb +249 -0
  21. data/lib/ultracart_api/models/sfvb_docs_gap_report_gap.rb +262 -0
  22. data/lib/ultracart_api/models/sfvb_item_preorder.rb +347 -0
  23. data/lib/ultracart_api/models/sfvb_item_preorder_change.rb +250 -0
  24. data/lib/ultracart_api/models/sfvb_item_preorder_child_row.rb +230 -0
  25. data/lib/ultracart_api/models/sfvb_item_preorder_children_request.rb +252 -0
  26. data/lib/ultracart_api/models/sfvb_item_preorder_list_response.rb +231 -0
  27. data/lib/ultracart_api/models/sfvb_item_preorder_option.rb +230 -0
  28. data/lib/ultracart_api/models/sfvb_item_preorder_request.rb +240 -0
  29. data/lib/ultracart_api/models/sfvb_whoami_response.rb +21 -1
  30. data/lib/ultracart_api/models/tax_jar_config.rb +11 -1
  31. data/lib/ultracart_api/version.rb +1 -1
  32. data/lib/ultracart_api.rb +10 -0
  33. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2a8a77fdbcb06626612fb2c45143363c0fc2ce2a416fc40a2dff9d4b05fe4fb7
4
- data.tar.gz: 57463d55c645b4cf69f4afdffa0d1cd3628c768362e5eda7e766f65c3c74426a
3
+ metadata.gz: 45d8cd786cfd224398bf8df07922d40dc957d1c5a2fee5c3c5c3ff04b0bfd197
4
+ data.tar.gz: e0c3dfacc8aa700fe58604eb044da63b47586f2c7103b3a44c8a8a6be282bc68
5
5
  SHA512:
6
- metadata.gz: a91b11371c73f15d8cbf949696d5305183f0ae49c9c26ace14d4be6344965ec58c053deecabd2c87a764296db4c1d54e69540633377963bf272529de58507ebf
7
- data.tar.gz: 71c5d24116ad8f3391d0d5d80a5bc49eba0b4a829a42a8dc5f6e921242c11a6fde17d03755e271db3c67a18f13fea3f009b85f1f4b7dda6a6af04700215dbe13
6
+ metadata.gz: 38624decd086efcb664fd0b216f098b8ea03a0cd23379a447dd707b77102a9b5b887875bcf774229cb5c0db00209abac74f00f922a107bacd18ea8dd53a2ad63
7
+ data.tar.gz: 1b83dbc7221d22b99049224dd386e47c3972e92a5cad9013a8cccd2259d166d0a0af9abf4f4d8af4e87160ef09fadcdb391f5640922bf7c0598bc2f9f361a1c8
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.236
10
+ - Package version: 4.1.238
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.236'
19
+ gem 'ultracart_api', '4.1.238'
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
@@ -585,6 +586,8 @@ Class | Method | HTTP request | Description
585
586
  *UltracartClient::SfvbApi* | [**get_sfvb_i18n_message**](docs/SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message
586
587
  *UltracartClient::SfvbApi* | [**get_sfvb_i18n_message_machine_translations**](docs/SfvbApi.md#get_sfvb_i18n_message_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations | Read where a message's translations come from
587
588
  *UltracartClient::SfvbApi* | [**get_sfvb_item**](docs/SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content
589
+ *UltracartClient::SfvbApi* | [**get_sfvb_item_preorder**](docs/SfvbApi.md#get_sfvb_item_preorder) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder | Read an item's pre-order flag and ETA
590
+ *UltracartClient::SfvbApi* | [**get_sfvb_item_preorder_children**](docs/SfvbApi.md#get_sfvb_item_preorder_children) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Read the pre-order flag and ETA of a parent item's variations
588
591
  *UltracartClient::SfvbApi* | [**get_sfvb_item_pricing**](docs/SfvbApi.md#get_sfvb_item_pricing) | **GET** /sfvb/storefronts/{storefront_oid}/items/pricing | Read what an item charges
589
592
  *UltracartClient::SfvbApi* | [**get_sfvb_item_related**](docs/SfvbApi.md#get_sfvb_item_related) | **GET** /sfvb/storefronts/{storefront_oid}/items/related | Read an item's related items
590
593
  *UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
@@ -649,6 +652,7 @@ Class | Method | HTTP request | Description
649
652
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
650
653
  *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
654
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
655
+ *UltracartClient::SfvbApi* | [**insert_sfvb_docs_gap**](docs/SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report
652
656
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
653
657
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
654
658
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
@@ -691,6 +695,8 @@ Class | Method | HTTP request | Description
691
695
  *UltracartClient::SfvbApi* | [**put_sfvb_item_content**](docs/SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description
692
696
  *UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia**](docs/SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item
693
697
  *UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia_description**](docs/SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description
698
+ *UltracartClient::SfvbApi* | [**put_sfvb_item_preorder**](docs/SfvbApi.md#put_sfvb_item_preorder) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder | Change an item's pre-order flag or ETA
699
+ *UltracartClient::SfvbApi* | [**put_sfvb_item_preorder_children**](docs/SfvbApi.md#put_sfvb_item_preorder_children) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Change the pre-order flag or ETA of several variations of one parent
694
700
  *UltracartClient::SfvbApi* | [**put_sfvb_item_pricing**](docs/SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges
695
701
  *UltracartClient::SfvbApi* | [**put_sfvb_item_related**](docs/SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items
696
702
  *UltracartClient::SfvbApi* | [**put_sfvb_item_seo**](docs/SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata
@@ -2086,6 +2092,9 @@ Class | Method | HTTP request | Description
2086
2092
  - [UltracartClient::SfvbContainerVersion](docs/SfvbContainerVersion.md)
2087
2093
  - [UltracartClient::SfvbContainerVersionsResponse](docs/SfvbContainerVersionsResponse.md)
2088
2094
  - [UltracartClient::SfvbContainerWriteRequest](docs/SfvbContainerWriteRequest.md)
2095
+ - [UltracartClient::SfvbDocsGap](docs/SfvbDocsGap.md)
2096
+ - [UltracartClient::SfvbDocsGapReport](docs/SfvbDocsGapReport.md)
2097
+ - [UltracartClient::SfvbDocsGapReportGap](docs/SfvbDocsGapReportGap.md)
2089
2098
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
2090
2099
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
2091
2100
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
@@ -2150,6 +2159,13 @@ Class | Method | HTTP request | Description
2150
2159
  - [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
2151
2160
  - [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
2152
2161
  - [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
2162
+ - [UltracartClient::SfvbItemPreorder](docs/SfvbItemPreorder.md)
2163
+ - [UltracartClient::SfvbItemPreorderChange](docs/SfvbItemPreorderChange.md)
2164
+ - [UltracartClient::SfvbItemPreorderChildRow](docs/SfvbItemPreorderChildRow.md)
2165
+ - [UltracartClient::SfvbItemPreorderChildrenRequest](docs/SfvbItemPreorderChildrenRequest.md)
2166
+ - [UltracartClient::SfvbItemPreorderListResponse](docs/SfvbItemPreorderListResponse.md)
2167
+ - [UltracartClient::SfvbItemPreorderOption](docs/SfvbItemPreorderOption.md)
2168
+ - [UltracartClient::SfvbItemPreorderRequest](docs/SfvbItemPreorderRequest.md)
2153
2169
  - [UltracartClient::SfvbItemPricing](docs/SfvbItemPricing.md)
2154
2170
  - [UltracartClient::SfvbItemPricingRequest](docs/SfvbItemPricingRequest.md)
2155
2171
  - [UltracartClient::SfvbItemRelated](docs/SfvbItemRelated.md)
@@ -2540,6 +2556,8 @@ Not every change is committed to every SDK.
2540
2556
 
2541
2557
  | Version | Date | Comments |
2542
2558
  | --: | :-: | --- |
2559
+ | 4.1.238 | 11/10/2026 | sfvb internal testing |
2560
+ | 4.1.237 | 11/10/2026 | sfvb internal testing |
2543
2561
  | 4.1.236 | 11/09/2026 | sfvb internal testing |
2544
2562
  | 4.1.235 | 11/09/2026 | sfvb internal testing |
2545
2563
  | 4.1.234 | 11/09/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 |
@@ -113,6 +114,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
113
114
  | [**get_sfvb_i18n_message**](SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message |
114
115
  | [**get_sfvb_i18n_message_machine_translations**](SfvbApi.md#get_sfvb_i18n_message_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations | Read where a message's translations come from |
115
116
  | [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
117
+ | [**get_sfvb_item_preorder**](SfvbApi.md#get_sfvb_item_preorder) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder | Read an item's pre-order flag and ETA |
118
+ | [**get_sfvb_item_preorder_children**](SfvbApi.md#get_sfvb_item_preorder_children) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Read the pre-order flag and ETA of a parent item's variations |
116
119
  | [**get_sfvb_item_pricing**](SfvbApi.md#get_sfvb_item_pricing) | **GET** /sfvb/storefronts/{storefront_oid}/items/pricing | Read what an item charges |
117
120
  | [**get_sfvb_item_related**](SfvbApi.md#get_sfvb_item_related) | **GET** /sfvb/storefronts/{storefront_oid}/items/related | Read an item's related items |
118
121
  | [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
@@ -177,6 +180,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
177
180
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
178
181
  | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
179
182
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
183
+ | [**insert_sfvb_docs_gap**](SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report |
180
184
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
181
185
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
182
186
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
@@ -219,6 +223,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
219
223
  | [**put_sfvb_item_content**](SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description |
220
224
  | [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
221
225
  | [**put_sfvb_item_multimedia_description**](SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description |
226
+ | [**put_sfvb_item_preorder**](SfvbApi.md#put_sfvb_item_preorder) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder | Change an item's pre-order flag or ETA |
227
+ | [**put_sfvb_item_preorder_children**](SfvbApi.md#put_sfvb_item_preorder_children) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Change the pre-order flag or ETA of several variations of one parent |
222
228
  | [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
223
229
  | [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
224
230
  | [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
@@ -5406,6 +5412,59 @@ end
5406
5412
  - **Accept**: application/json
5407
5413
 
5408
5414
 
5415
+ ## get_sfvb_docs_gap
5416
+
5417
+ > <SfvbDocsGap> get_sfvb_docs_gap(report_id)
5418
+
5419
+ Get a documentation-gap report's status
5420
+
5421
+ 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.
5422
+
5423
+
5424
+ ### Examples
5425
+
5426
+
5427
+ (No example for this operation).
5428
+
5429
+
5430
+ #### Using the get_sfvb_docs_gap_with_http_info variant
5431
+
5432
+ This returns an Array which contains the response data, status code and headers.
5433
+
5434
+ > <Array(<SfvbDocsGap>, Integer, Hash)> get_sfvb_docs_gap_with_http_info(report_id)
5435
+
5436
+ ```ruby
5437
+ begin
5438
+ # Get a documentation-gap report's status
5439
+ data, status_code, headers = api_instance.get_sfvb_docs_gap_with_http_info(report_id)
5440
+ p status_code # => 2xx
5441
+ p headers # => { ... }
5442
+ p data # => <SfvbDocsGap>
5443
+ rescue UltracartClient::ApiError => e
5444
+ puts "Error when calling SfvbApi->get_sfvb_docs_gap_with_http_info: #{e}"
5445
+ end
5446
+ ```
5447
+
5448
+ ### Parameters
5449
+
5450
+ | Name | Type | Description | Notes |
5451
+ | ---- | ---- | ----------- | ----- |
5452
+ | **report_id** | **String** | | |
5453
+
5454
+ ### Return type
5455
+
5456
+ [**SfvbDocsGap**](SfvbDocsGap.md)
5457
+
5458
+ ### Authorization
5459
+
5460
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5461
+
5462
+ ### HTTP request headers
5463
+
5464
+ - **Content-Type**: Not defined
5465
+ - **Accept**: application/json
5466
+
5467
+
5409
5468
  ## get_sfvb_element
5410
5469
 
5411
5470
  > <SfvbElementSchemaResponse> get_sfvb_element(element_type)
@@ -6219,6 +6278,116 @@ end
6219
6278
  - **Accept**: application/json
6220
6279
 
6221
6280
 
6281
+ ## get_sfvb_item_preorder
6282
+
6283
+ > <SfvbItemPreorder> get_sfvb_item_preorder(storefront_oid, opts)
6284
+
6285
+ Read an item's pre-order flag and ETA
6286
+
6287
+ Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent's variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
6288
+
6289
+
6290
+ ### Examples
6291
+
6292
+
6293
+ (No example for this operation).
6294
+
6295
+
6296
+ #### Using the get_sfvb_item_preorder_with_http_info variant
6297
+
6298
+ This returns an Array which contains the response data, status code and headers.
6299
+
6300
+ > <Array(<SfvbItemPreorder>, Integer, Hash)> get_sfvb_item_preorder_with_http_info(storefront_oid, opts)
6301
+
6302
+ ```ruby
6303
+ begin
6304
+ # Read an item's pre-order flag and ETA
6305
+ data, status_code, headers = api_instance.get_sfvb_item_preorder_with_http_info(storefront_oid, opts)
6306
+ p status_code # => 2xx
6307
+ p headers # => { ... }
6308
+ p data # => <SfvbItemPreorder>
6309
+ rescue UltracartClient::ApiError => e
6310
+ puts "Error when calling SfvbApi->get_sfvb_item_preorder_with_http_info: #{e}"
6311
+ end
6312
+ ```
6313
+
6314
+ ### Parameters
6315
+
6316
+ | Name | Type | Description | Notes |
6317
+ | ---- | ---- | ----------- | ----- |
6318
+ | **storefront_oid** | **Integer** | | |
6319
+ | **merchant_item_id** | **String** | | [optional] |
6320
+ | **merchant_item_oid** | **Integer** | | [optional] |
6321
+
6322
+ ### Return type
6323
+
6324
+ [**SfvbItemPreorder**](SfvbItemPreorder.md)
6325
+
6326
+ ### Authorization
6327
+
6328
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6329
+
6330
+ ### HTTP request headers
6331
+
6332
+ - **Content-Type**: Not defined
6333
+ - **Accept**: application/json
6334
+
6335
+
6336
+ ## get_sfvb_item_preorder_children
6337
+
6338
+ > <SfvbItemPreorderListResponse> get_sfvb_item_preorder_children(storefront_oid, opts)
6339
+
6340
+ Read the pre-order flag and ETA of a parent item's variations
6341
+
6342
+ The parent's own values and each variation's, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
6343
+
6344
+
6345
+ ### Examples
6346
+
6347
+
6348
+ (No example for this operation).
6349
+
6350
+
6351
+ #### Using the get_sfvb_item_preorder_children_with_http_info variant
6352
+
6353
+ This returns an Array which contains the response data, status code and headers.
6354
+
6355
+ > <Array(<SfvbItemPreorderListResponse>, Integer, Hash)> get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts)
6356
+
6357
+ ```ruby
6358
+ begin
6359
+ # Read the pre-order flag and ETA of a parent item's variations
6360
+ data, status_code, headers = api_instance.get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts)
6361
+ p status_code # => 2xx
6362
+ p headers # => { ... }
6363
+ p data # => <SfvbItemPreorderListResponse>
6364
+ rescue UltracartClient::ApiError => e
6365
+ puts "Error when calling SfvbApi->get_sfvb_item_preorder_children_with_http_info: #{e}"
6366
+ end
6367
+ ```
6368
+
6369
+ ### Parameters
6370
+
6371
+ | Name | Type | Description | Notes |
6372
+ | ---- | ---- | ----------- | ----- |
6373
+ | **storefront_oid** | **Integer** | | |
6374
+ | **merchant_item_id** | **String** | | [optional] |
6375
+ | **merchant_item_oid** | **Integer** | | [optional] |
6376
+
6377
+ ### Return type
6378
+
6379
+ [**SfvbItemPreorderListResponse**](SfvbItemPreorderListResponse.md)
6380
+
6381
+ ### Authorization
6382
+
6383
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6384
+
6385
+ ### HTTP request headers
6386
+
6387
+ - **Content-Type**: Not defined
6388
+ - **Accept**: application/json
6389
+
6390
+
6222
6391
  ## get_sfvb_item_pricing
6223
6392
 
6224
6393
  > <SfvbItemPricing> get_sfvb_item_pricing(storefront_oid, opts)
@@ -9684,6 +9853,60 @@ end
9684
9853
  - **Accept**: application/json
9685
9854
 
9686
9855
 
9856
+ ## insert_sfvb_docs_gap
9857
+
9858
+ > <SfvbDocsGap> insert_sfvb_docs_gap(docs_gap_report, opts)
9859
+
9860
+ Send UltraCart a documentation-gap report
9861
+
9862
+ 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.
9863
+
9864
+
9865
+ ### Examples
9866
+
9867
+
9868
+ (No example for this operation).
9869
+
9870
+
9871
+ #### Using the insert_sfvb_docs_gap_with_http_info variant
9872
+
9873
+ This returns an Array which contains the response data, status code and headers.
9874
+
9875
+ > <Array(<SfvbDocsGap>, Integer, Hash)> insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
9876
+
9877
+ ```ruby
9878
+ begin
9879
+ # Send UltraCart a documentation-gap report
9880
+ data, status_code, headers = api_instance.insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
9881
+ p status_code # => 2xx
9882
+ p headers # => { ... }
9883
+ p data # => <SfvbDocsGap>
9884
+ rescue UltracartClient::ApiError => e
9885
+ puts "Error when calling SfvbApi->insert_sfvb_docs_gap_with_http_info: #{e}"
9886
+ end
9887
+ ```
9888
+
9889
+ ### Parameters
9890
+
9891
+ | Name | Type | Description | Notes |
9892
+ | ---- | ---- | ----------- | ----- |
9893
+ | **docs_gap_report** | [**SfvbDocsGapReport**](SfvbDocsGapReport.md) | The report | |
9894
+ | **storefront_oid** | **Integer** | The storefront the agent was working on, recorded for context. Leave it out when none applies. | [optional] |
9895
+
9896
+ ### Return type
9897
+
9898
+ [**SfvbDocsGap**](SfvbDocsGap.md)
9899
+
9900
+ ### Authorization
9901
+
9902
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9903
+
9904
+ ### HTTP request headers
9905
+
9906
+ - **Content-Type**: application/json; charset=UTF-8
9907
+ - **Accept**: application/json
9908
+
9909
+
9687
9910
  ## insert_sfvb_page
9688
9911
 
9689
9912
  > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
@@ -12010,6 +12233,121 @@ end
12010
12233
  - **Accept**: application/json
12011
12234
 
12012
12235
 
12236
+ ## put_sfvb_item_preorder
12237
+
12238
+ > <SfvbItemPreorder> put_sfvb_item_preorder(storefront_oid, if_match, item_preorder_request, opts)
12239
+
12240
+ Change an item's pre-order flag or ETA
12241
+
12242
+ Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
12243
+
12244
+
12245
+ ### Examples
12246
+
12247
+
12248
+ (No example for this operation).
12249
+
12250
+
12251
+ #### Using the put_sfvb_item_preorder_with_http_info variant
12252
+
12253
+ This returns an Array which contains the response data, status code and headers.
12254
+
12255
+ > <Array(<SfvbItemPreorder>, Integer, Hash)> put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts)
12256
+
12257
+ ```ruby
12258
+ begin
12259
+ # Change an item's pre-order flag or ETA
12260
+ data, status_code, headers = api_instance.put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts)
12261
+ p status_code # => 2xx
12262
+ p headers # => { ... }
12263
+ p data # => <SfvbItemPreorder>
12264
+ rescue UltracartClient::ApiError => e
12265
+ puts "Error when calling SfvbApi->put_sfvb_item_preorder_with_http_info: #{e}"
12266
+ end
12267
+ ```
12268
+
12269
+ ### Parameters
12270
+
12271
+ | Name | Type | Description | Notes |
12272
+ | ---- | ---- | ----------- | ----- |
12273
+ | **storefront_oid** | **Integer** | | |
12274
+ | **if_match** | **String** | hash_sha256 from the pre-order read. Required; 428 when absent, 412 when stale. | |
12275
+ | **item_preorder_request** | [**SfvbItemPreorderRequest**](SfvbItemPreorderRequest.md) | The change | |
12276
+ | **merchant_item_id** | **String** | | [optional] |
12277
+ | **merchant_item_oid** | **Integer** | | [optional] |
12278
+ | **approval_id** | **String** | The approval_id of an approved item.preorder request for this item and change. Required when the change puts the item on or off pre-order. See POST /sfvb/approvals. | [optional] |
12279
+
12280
+ ### Return type
12281
+
12282
+ [**SfvbItemPreorder**](SfvbItemPreorder.md)
12283
+
12284
+ ### Authorization
12285
+
12286
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12287
+
12288
+ ### HTTP request headers
12289
+
12290
+ - **Content-Type**: application/json; charset=UTF-8
12291
+ - **Accept**: application/json
12292
+
12293
+
12294
+ ## put_sfvb_item_preorder_children
12295
+
12296
+ > <SfvbItemPreorderListResponse> put_sfvb_item_preorder_children(storefront_oid, item_preorder_children_request, opts)
12297
+
12298
+ Change the pre-order flag or ETA of several variations of one parent
12299
+
12300
+ The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
12301
+
12302
+
12303
+ ### Examples
12304
+
12305
+
12306
+ (No example for this operation).
12307
+
12308
+
12309
+ #### Using the put_sfvb_item_preorder_children_with_http_info variant
12310
+
12311
+ This returns an Array which contains the response data, status code and headers.
12312
+
12313
+ > <Array(<SfvbItemPreorderListResponse>, Integer, Hash)> put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts)
12314
+
12315
+ ```ruby
12316
+ begin
12317
+ # Change the pre-order flag or ETA of several variations of one parent
12318
+ data, status_code, headers = api_instance.put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts)
12319
+ p status_code # => 2xx
12320
+ p headers # => { ... }
12321
+ p data # => <SfvbItemPreorderListResponse>
12322
+ rescue UltracartClient::ApiError => e
12323
+ puts "Error when calling SfvbApi->put_sfvb_item_preorder_children_with_http_info: #{e}"
12324
+ end
12325
+ ```
12326
+
12327
+ ### Parameters
12328
+
12329
+ | Name | Type | Description | Notes |
12330
+ | ---- | ---- | ----------- | ----- |
12331
+ | **storefront_oid** | **Integer** | | |
12332
+ | **item_preorder_children_request** | [**SfvbItemPreorderChildrenRequest**](SfvbItemPreorderChildrenRequest.md) | The change and the variations | |
12333
+ | **merchant_item_id** | **String** | | [optional] |
12334
+ | **merchant_item_oid** | **Integer** | | [optional] |
12335
+ | **approval_id** | **String** | The approval_id of an approved item.preorder request for the parent and this change. Required when the change puts any variation on or off pre-order. See POST /sfvb/approvals. | [optional] |
12336
+
12337
+ ### Return type
12338
+
12339
+ [**SfvbItemPreorderListResponse**](SfvbItemPreorderListResponse.md)
12340
+
12341
+ ### Authorization
12342
+
12343
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12344
+
12345
+ ### HTTP request headers
12346
+
12347
+ - **Content-Type**: application/json; charset=UTF-8
12348
+ - **Accept**: application/json
12349
+
12350
+
12013
12351
  ## put_sfvb_item_pricing
12014
12352
 
12015
12353
  > <SfvbItemPricing> put_sfvb_item_pricing(storefront_oid, if_match, item_pricing_request, opts)
@@ -12,6 +12,8 @@
12
12
  | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
13
13
  | **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
14
14
  | **item_attribute_rows** | [**Array&lt;SfvbItemAttributeBatchRow&gt;**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run&#39;s change rows, each with merchant_item_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
15
+ | **item_preorder** | [**SfvbItemPreorderRequest**](SfvbItemPreorderRequest.md) | | [optional] |
16
+ | **item_preorder_children** | [**SfvbItemPreorderChildrenRequest**](SfvbItemPreorderChildrenRequest.md) | | [optional] |
15
17
  | **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) | | [optional] |
16
18
  | **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
17
19
  | **postcard_test_mail** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) | | [optional] |
@@ -37,6 +39,8 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
37
39
  experiment_start: null,
38
40
  flow_backfill: null,
39
41
  item_attribute_rows: null,
42
+ item_preorder: null,
43
+ item_preorder_children: null,
40
44
  item_pricing: null,
41
45
  params: null,
42
46
  postcard_test_mail: null,
@@ -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
+
@@ -0,0 +1,36 @@
1
+ # UltracartClient::SfvbItemPreorder
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **changed** | [**SfvbItemPreorderChange**](SfvbItemPreorderChange.md) | | [optional] |
8
+ | **eta** | **String** | The expected date, YYYY-MM-DD, or null when none is set. | [optional] |
9
+ | **hash_sha256** | **String** | The hash of preorder and eta. Send it as If-Match, or as the row&#39;s hash_sha256, to change them. | [optional] |
10
+ | **merchant_item_id** | **String** | The item&#39;s merchant item id. | [optional] |
11
+ | **merchant_item_oid** | **Integer** | The item. | [optional] |
12
+ | **preorder** | **Boolean** | True when the item is on pre-order. Shoppers can order it while out of stock, and its orders go to the Pre-ordered stage. | [optional] |
13
+ | **shoppers_see** | **String** | What itempreorder shows. preorder_with_eta when on pre-order with an ETA of today or later, preorder_no_eta when on pre-order with no ETA or a past one, nothing when not on pre-order. | [optional] |
14
+ | **shoppers_see_text** | **String** | shoppers_see in words, such as on pre-order, ETA 2026-11-20. | [optional] |
15
+ | **variation_values** | [**Array&lt;SfvbItemPreorderOption&gt;**](SfvbItemPreorderOption.md) | For a variation listed under its parent, the option values that pick it, such as Size 2T. | [optional] |
16
+ | **warnings** | **Array&lt;String&gt;** | After a change, things worth knowing about the new values, such as an ETA in the past. Never a refusal. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::SfvbItemPreorder.new(
24
+ changed: null,
25
+ eta: null,
26
+ hash_sha256: null,
27
+ merchant_item_id: null,
28
+ merchant_item_oid: null,
29
+ preorder: null,
30
+ shoppers_see: null,
31
+ shoppers_see_text: null,
32
+ variation_values: null,
33
+ warnings: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbItemPreorderChange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **eta_after** | **String** | The ETA after the change, YYYY-MM-DD, or null. | [optional] |
8
+ | **eta_before** | **String** | The ETA before the change, YYYY-MM-DD, or null. | [optional] |
9
+ | **preorder_after** | **Boolean** | Pre-order after the change. | [optional] |
10
+ | **preorder_before** | **Boolean** | Pre-order before the change. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbItemPreorderChange.new(
18
+ eta_after: null,
19
+ eta_before: null,
20
+ preorder_after: null,
21
+ preorder_before: null
22
+ )
23
+ ```
24
+