ultracart_api 4.1.200 → 4.1.202
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 +4 -4
- data/README.md +12 -2
- data/docs/OauthApi.md +1 -1
- data/docs/SfvbApi.md +171 -3
- data/docs/SfvbContainerVersion.md +1 -1
- data/docs/SfvbEvent.md +28 -0
- data/docs/SfvbEventsAuthRequest.md +18 -0
- data/docs/SfvbEventsAuthResponse.md +22 -0
- data/docs/SfvbEventsResponse.md +22 -0
- data/docs/SfvbI18nMessageValue.md +1 -1
- data/docs/SfvbItemMultimedia.md +9 -1
- data/docs/SfvbItemMultimediaDescriptionRequest.md +26 -0
- data/docs/SfvbThemeJobResponse.md +3 -3
- data/lib/ultracart_api/api/oauth_api.rb +2 -2
- data/lib/ultracart_api/api/sfvb_api.rb +222 -6
- data/lib/ultracart_api/models/sfvb_container_version.rb +1 -1
- data/lib/ultracart_api/models/sfvb_event.rb +270 -0
- data/lib/ultracart_api/models/sfvb_events_auth_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_events_auth_response.rb +240 -0
- data/lib/ultracart_api/models/sfvb_events_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_i18n_message_value.rb +1 -1
- data/lib/ultracart_api/models/sfvb_item_multimedia.rb +54 -2
- data/lib/ultracart_api/models/sfvb_item_multimedia_description_request.rb +260 -0
- data/lib/ultracart_api/models/sfvb_theme_job_response.rb +3 -3
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c8e2a0df2a48694c297eccac324214153614a364647f403482a52863732a8d42
|
|
4
|
+
data.tar.gz: 6391ca2c7f7f14054a3c351fb22165e8e8f793c0685af64e4deefd5c33dd3928
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d2f086140b99df10e1fc950f74e5bb323b83289356a330c6ea78499c271c73a5a1b1085ae108a30d1a089c622ed65cde9fbf170521c97a91cbd2ee853f5e6ac3
|
|
7
|
+
data.tar.gz: 53ec4581fefb66a0b5021744599a789c9e4e634b9b017b4dd1980e118ee46fabaf7f31272e815ca39e06fd7369eadd8f2df00acd0b861f59fb84c9898bb51d25
|
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.
|
|
10
|
+
- Package version: 4.1.202
|
|
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.
|
|
19
|
+
gem 'ultracart_api', '4.1.202'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -521,6 +521,8 @@ Class | Method | HTTP request | Description
|
|
|
521
521
|
*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
|
|
522
522
|
*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
|
|
523
523
|
*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
|
|
524
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_events**](docs/SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events
|
|
525
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_events_authorization**](docs/SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream
|
|
524
526
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment**](docs/SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics
|
|
525
527
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment_objectives**](docs/SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize
|
|
526
528
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
@@ -597,6 +599,7 @@ Class | Method | HTTP request | Description
|
|
|
597
599
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_attributes**](docs/SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes
|
|
598
600
|
*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
|
|
599
601
|
*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
|
|
602
|
+
*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
|
|
600
603
|
*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
|
|
601
604
|
*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
|
|
602
605
|
*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
|
|
@@ -1888,6 +1891,10 @@ Class | Method | HTTP request | Description
|
|
|
1888
1891
|
- [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
|
|
1889
1892
|
- [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
|
|
1890
1893
|
- [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
|
|
1894
|
+
- [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
|
|
1895
|
+
- [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
|
|
1896
|
+
- [UltracartClient::SfvbEventsAuthResponse](docs/SfvbEventsAuthResponse.md)
|
|
1897
|
+
- [UltracartClient::SfvbEventsResponse](docs/SfvbEventsResponse.md)
|
|
1891
1898
|
- [UltracartClient::SfvbExperiment](docs/SfvbExperiment.md)
|
|
1892
1899
|
- [UltracartClient::SfvbExperimentEndRequest](docs/SfvbExperimentEndRequest.md)
|
|
1893
1900
|
- [UltracartClient::SfvbExperimentObjective](docs/SfvbExperimentObjective.md)
|
|
@@ -1931,6 +1938,7 @@ Class | Method | HTTP request | Description
|
|
|
1931
1938
|
- [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
|
|
1932
1939
|
- [UltracartClient::SfvbItemContentRequest](docs/SfvbItemContentRequest.md)
|
|
1933
1940
|
- [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
|
|
1941
|
+
- [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
|
|
1934
1942
|
- [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
|
|
1935
1943
|
- [UltracartClient::SfvbItemPricing](docs/SfvbItemPricing.md)
|
|
1936
1944
|
- [UltracartClient::SfvbItemPricingRequest](docs/SfvbItemPricingRequest.md)
|
|
@@ -2244,6 +2252,8 @@ Not every change is committed to every SDK.
|
|
|
2244
2252
|
|
|
2245
2253
|
| Version | Date | Comments |
|
|
2246
2254
|
| --: | :-: | --- |
|
|
2255
|
+
| 4.1.202 | 10/13/2026 | sfvb internal testing |
|
|
2256
|
+
| 4.1.201 | 10/12/2026 | sfvb internal testing |
|
|
2247
2257
|
| 4.1.200 | 10/09/2026 | sfvb internal testing |
|
|
2248
2258
|
| 4.1.199 | 10/08/2026 | sfvb internal testing |
|
|
2249
2259
|
| 4.1.198 | 10/08/2026 | sfvb internal testing |
|
data/docs/OauthApi.md
CHANGED
|
@@ -294,7 +294,7 @@ end
|
|
|
294
294
|
| Name | Type | Description | Notes |
|
|
295
295
|
| ---- | ---- | ----------- | ----- |
|
|
296
296
|
| **client_id** | **String** | The OAuth application client_id. | |
|
|
297
|
-
| **token** | **String** | The OAuth access token that is to be revoked
|
|
297
|
+
| **token** | **String** | The OAuth access token or refresh token that is to be revoked. | |
|
|
298
298
|
|
|
299
299
|
### Return type
|
|
300
300
|
|
data/docs/SfvbApi.md
CHANGED
|
@@ -49,6 +49,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
49
49
|
| [**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 |
|
|
50
50
|
| [**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 |
|
|
51
51
|
| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
|
|
52
|
+
| [**get_sfvb_events**](SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events |
|
|
53
|
+
| [**get_sfvb_events_authorization**](SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream |
|
|
52
54
|
| [**get_sfvb_experiment**](SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics |
|
|
53
55
|
| [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
|
|
54
56
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
@@ -125,6 +127,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
125
127
|
| [**put_sfvb_item_attributes**](SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes |
|
|
126
128
|
| [**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 |
|
|
127
129
|
| [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
|
|
130
|
+
| [**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 |
|
|
128
131
|
| [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
|
|
129
132
|
| [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
|
|
130
133
|
| [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
|
|
@@ -2141,7 +2144,7 @@ end
|
|
|
2141
2144
|
|
|
2142
2145
|
End an experiment
|
|
2143
2146
|
|
|
2144
|
-
Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
2147
|
+
Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person's approval session (see POST /sfvb/approvals).
|
|
2145
2148
|
|
|
2146
2149
|
|
|
2147
2150
|
### Examples
|
|
@@ -2620,6 +2623,114 @@ end
|
|
|
2620
2623
|
- **Accept**: application/json
|
|
2621
2624
|
|
|
2622
2625
|
|
|
2626
|
+
## get_sfvb_events
|
|
2627
|
+
|
|
2628
|
+
> <SfvbEventsResponse> get_sfvb_events(opts)
|
|
2629
|
+
|
|
2630
|
+
Replay events
|
|
2631
|
+
|
|
2632
|
+
The signed-in person's events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in's requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
### Examples
|
|
2636
|
+
|
|
2637
|
+
|
|
2638
|
+
(No example for this operation).
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
#### Using the get_sfvb_events_with_http_info variant
|
|
2642
|
+
|
|
2643
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2644
|
+
|
|
2645
|
+
> <Array(<SfvbEventsResponse>, Integer, Hash)> get_sfvb_events_with_http_info(opts)
|
|
2646
|
+
|
|
2647
|
+
```ruby
|
|
2648
|
+
begin
|
|
2649
|
+
# Replay events
|
|
2650
|
+
data, status_code, headers = api_instance.get_sfvb_events_with_http_info(opts)
|
|
2651
|
+
p status_code # => 2xx
|
|
2652
|
+
p headers # => { ... }
|
|
2653
|
+
p data # => <SfvbEventsResponse>
|
|
2654
|
+
rescue UltracartClient::ApiError => e
|
|
2655
|
+
puts "Error when calling SfvbApi->get_sfvb_events_with_http_info: #{e}"
|
|
2656
|
+
end
|
|
2657
|
+
```
|
|
2658
|
+
|
|
2659
|
+
### Parameters
|
|
2660
|
+
|
|
2661
|
+
| Name | Type | Description | Notes |
|
|
2662
|
+
| ---- | ---- | ----------- | ----- |
|
|
2663
|
+
| **after** | **String** | Return events after this event_id. Leave it out for every event kept. | [optional] |
|
|
2664
|
+
| **storefront_oid** | **Integer** | Only events about this storefront, plus merchant-level ones. | [optional] |
|
|
2665
|
+
| **limit** | **Integer** | At most this many events, 1 to 500. | [optional] |
|
|
2666
|
+
|
|
2667
|
+
### Return type
|
|
2668
|
+
|
|
2669
|
+
[**SfvbEventsResponse**](SfvbEventsResponse.md)
|
|
2670
|
+
|
|
2671
|
+
### Authorization
|
|
2672
|
+
|
|
2673
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2674
|
+
|
|
2675
|
+
### HTTP request headers
|
|
2676
|
+
|
|
2677
|
+
- **Content-Type**: Not defined
|
|
2678
|
+
- **Accept**: application/json
|
|
2679
|
+
|
|
2680
|
+
|
|
2681
|
+
## get_sfvb_events_authorization
|
|
2682
|
+
|
|
2683
|
+
> <SfvbEventsAuthResponse> get_sfvb_events_authorization(opts)
|
|
2684
|
+
|
|
2685
|
+
Open the event stream
|
|
2686
|
+
|
|
2687
|
+
Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person's event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
### Examples
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
(No example for this operation).
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
#### Using the get_sfvb_events_authorization_with_http_info variant
|
|
2697
|
+
|
|
2698
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2699
|
+
|
|
2700
|
+
> <Array(<SfvbEventsAuthResponse>, Integer, Hash)> get_sfvb_events_authorization_with_http_info(opts)
|
|
2701
|
+
|
|
2702
|
+
```ruby
|
|
2703
|
+
begin
|
|
2704
|
+
# Open the event stream
|
|
2705
|
+
data, status_code, headers = api_instance.get_sfvb_events_authorization_with_http_info(opts)
|
|
2706
|
+
p status_code # => 2xx
|
|
2707
|
+
p headers # => { ... }
|
|
2708
|
+
p data # => <SfvbEventsAuthResponse>
|
|
2709
|
+
rescue UltracartClient::ApiError => e
|
|
2710
|
+
puts "Error when calling SfvbApi->get_sfvb_events_authorization_with_http_info: #{e}"
|
|
2711
|
+
end
|
|
2712
|
+
```
|
|
2713
|
+
|
|
2714
|
+
### Parameters
|
|
2715
|
+
|
|
2716
|
+
| Name | Type | Description | Notes |
|
|
2717
|
+
| ---- | ---- | ----------- | ----- |
|
|
2718
|
+
| **events_auth_request** | [**SfvbEventsAuthRequest**](SfvbEventsAuthRequest.md) | Optional storefront filter | [optional] |
|
|
2719
|
+
|
|
2720
|
+
### Return type
|
|
2721
|
+
|
|
2722
|
+
[**SfvbEventsAuthResponse**](SfvbEventsAuthResponse.md)
|
|
2723
|
+
|
|
2724
|
+
### Authorization
|
|
2725
|
+
|
|
2726
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2727
|
+
|
|
2728
|
+
### HTTP request headers
|
|
2729
|
+
|
|
2730
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
2731
|
+
- **Accept**: application/json
|
|
2732
|
+
|
|
2733
|
+
|
|
2623
2734
|
## get_sfvb_experiment
|
|
2624
2735
|
|
|
2625
2736
|
> <SfvbExperiment> get_sfvb_experiment(storefront_oid, experiment_oid, opts)
|
|
@@ -3602,7 +3713,7 @@ end
|
|
|
3602
3713
|
|
|
3603
3714
|
List the paths that answered 404
|
|
3604
3715
|
|
|
3605
|
-
The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
3716
|
+
The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
3606
3717
|
|
|
3607
3718
|
|
|
3608
3719
|
### Examples
|
|
@@ -3640,6 +3751,7 @@ end
|
|
|
3640
3751
|
| **include_tokens** | **Boolean** | | [optional] |
|
|
3641
3752
|
| **q** | **String** | | [optional] |
|
|
3642
3753
|
| **limit** | **Integer** | | [optional] |
|
|
3754
|
+
| **redirected** | **Boolean** | | [optional] |
|
|
3643
3755
|
|
|
3644
3756
|
### Return type
|
|
3645
3757
|
|
|
@@ -6564,7 +6676,7 @@ end
|
|
|
6564
6676
|
|
|
6565
6677
|
Change one built-in message
|
|
6566
6678
|
|
|
6567
|
-
Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
6679
|
+
Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language's translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can't be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
6568
6680
|
|
|
6569
6681
|
|
|
6570
6682
|
### Examples
|
|
@@ -6783,6 +6895,62 @@ end
|
|
|
6783
6895
|
- **Accept**: application/json
|
|
6784
6896
|
|
|
6785
6897
|
|
|
6898
|
+
## put_sfvb_item_multimedia_description
|
|
6899
|
+
|
|
6900
|
+
> <SfvbItemResponse> put_sfvb_item_multimedia_description(storefront_oid, item_multimedia_description_request, opts)
|
|
6901
|
+
|
|
6902
|
+
Change an item image's description
|
|
6903
|
+
|
|
6904
|
+
Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
6905
|
+
|
|
6906
|
+
|
|
6907
|
+
### Examples
|
|
6908
|
+
|
|
6909
|
+
|
|
6910
|
+
(No example for this operation).
|
|
6911
|
+
|
|
6912
|
+
|
|
6913
|
+
#### Using the put_sfvb_item_multimedia_description_with_http_info variant
|
|
6914
|
+
|
|
6915
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6916
|
+
|
|
6917
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
|
|
6918
|
+
|
|
6919
|
+
```ruby
|
|
6920
|
+
begin
|
|
6921
|
+
# Change an item image's description
|
|
6922
|
+
data, status_code, headers = api_instance.put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
|
|
6923
|
+
p status_code # => 2xx
|
|
6924
|
+
p headers # => { ... }
|
|
6925
|
+
p data # => <SfvbItemResponse>
|
|
6926
|
+
rescue UltracartClient::ApiError => e
|
|
6927
|
+
puts "Error when calling SfvbApi->put_sfvb_item_multimedia_description_with_http_info: #{e}"
|
|
6928
|
+
end
|
|
6929
|
+
```
|
|
6930
|
+
|
|
6931
|
+
### Parameters
|
|
6932
|
+
|
|
6933
|
+
| Name | Type | Description | Notes |
|
|
6934
|
+
| ---- | ---- | ----------- | ----- |
|
|
6935
|
+
| **storefront_oid** | **Integer** | | |
|
|
6936
|
+
| **item_multimedia_description_request** | [**SfvbItemMultimediaDescriptionRequest**](SfvbItemMultimediaDescriptionRequest.md) | The image and its new description | |
|
|
6937
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
6938
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
6939
|
+
|
|
6940
|
+
### Return type
|
|
6941
|
+
|
|
6942
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
6943
|
+
|
|
6944
|
+
### Authorization
|
|
6945
|
+
|
|
6946
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6947
|
+
|
|
6948
|
+
### HTTP request headers
|
|
6949
|
+
|
|
6950
|
+
- **Content-Type**: application/json
|
|
6951
|
+
- **Accept**: application/json
|
|
6952
|
+
|
|
6953
|
+
|
|
6786
6954
|
## put_sfvb_item_pricing
|
|
6787
6955
|
|
|
6788
6956
|
> <SfvbItemPricing> put_sfvb_item_pricing(storefront_oid, if_match, item_pricing_request, opts)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **comment** | **String** | Comment recorded with the write that replaced this version. | [optional] |
|
|
9
9
|
| **container_history_oid** | **Integer** | History record oid. Pass to the revert operation on the owning container. Absent on the entry marked current, which holds the value stored right now, has no history row of its own, and so cannot be fetched or reverted to. | [optional] |
|
|
10
10
|
| **container_name** | **String** | Container name, where the owner has more than one container. | [optional] |
|
|
11
|
-
| **created_dts** | **String** | When this snapshot was taken. | [optional] |
|
|
11
|
+
| **created_dts** | **String** | When this snapshot was taken, ISO 8601 UTC. | [optional] |
|
|
12
12
|
| **current** | **Boolean** | True for the value currently stored. | [optional] |
|
|
13
13
|
| **edited_by** | **String** | Login of whoever caused this snapshot. | [optional] |
|
|
14
14
|
| **hash_sha256** | **String** | SHA-256 of this version's CJSON. | [optional] |
|
data/docs/SfvbEvent.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbEvent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_dts** | **String** | When it happened, ISO 8601. | [optional] |
|
|
8
|
+
| **event_id** | **String** | Time-ordered id. Pass the last one seen as after to replay what came since. | [optional] |
|
|
9
|
+
| **object_id** | **String** | The id of what changed, such as the approval_id. | [optional] |
|
|
10
|
+
| **object_type** | **String** | What changed, such as approval. | [optional] |
|
|
11
|
+
| **storefront_oid** | **Integer** | The storefront it concerns. Empty for merchant-level objects. | [optional] |
|
|
12
|
+
| **type** | **String** | approval.decided (approved, denied, cancelled or refused by the script review) or approval.ready (the review finished and the person can decide). | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbEvent.new(
|
|
20
|
+
event_dts: null,
|
|
21
|
+
event_id: null,
|
|
22
|
+
object_id: null,
|
|
23
|
+
object_type: null,
|
|
24
|
+
storefront_oid: null,
|
|
25
|
+
type: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbEventsAuthRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **storefront_oids** | **Array<Integer>** | Only events about these storefronts, plus merchant-level ones. Leave it out for every storefront. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbEventsAuthRequest.new(
|
|
15
|
+
storefront_oids: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbEventsAuthResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expires_dts** | **String** | When the token stops working, ISO 8601. Ask for a new one to reconnect. | [optional] |
|
|
8
|
+
| **jwt** | **String** | The connect token on its own. | [optional] |
|
|
9
|
+
| **websocket_url** | **String** | The websocket URL to open, with the token on it. Open it before expires_dts; each token opens one connection. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbEventsAuthResponse.new(
|
|
17
|
+
expires_dts: null,
|
|
18
|
+
jwt: null,
|
|
19
|
+
websocket_url: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbEventsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **events** | [**Array<SfvbEvent>**](SfvbEvent.md) | Oldest first. | [optional] |
|
|
8
|
+
| **more** | **Boolean** | True when more events follow. Ask again with after set to the last event_id. | [optional] |
|
|
9
|
+
| **resync_required** | **Boolean** | True when the cursor is older than the 72 hours of events kept. Re-list what you were waiting on instead of replaying. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbEventsResponse.new(
|
|
17
|
+
events: null,
|
|
18
|
+
more: null,
|
|
19
|
+
resync_required: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **language** | **String** | The language code. ENG changes the English source, which clears its machine translations. | [optional] |
|
|
8
|
-
| **text** | **String** | The new text. Empty text
|
|
8
|
+
| **text** | **String** | The new text. Empty text removes this language's translation, so it goes back to machine translation. Empty English text is refused. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/SfvbItemMultimedia.md
CHANGED
|
@@ -7,10 +7,14 @@
|
|
|
7
7
|
| **code** | **String** | The image code, which is what an itemimage element's itemImageCode refers to. Empty for the default image. | [optional] |
|
|
8
8
|
| **declared** | **Boolean** | True when a template declares this code. A slot that is attached but not declared is an image nothing on the page is asking for. | [optional] |
|
|
9
9
|
| **default** | **Boolean** | True for the image an itemimage element with no code renders. Default is per media type, so an item may have one default image and one default PDF at the same time. | [optional] |
|
|
10
|
-
| **description** | **String** |
|
|
10
|
+
| **description** | **String** | The merchant's description, stored with the image and rendered as its alt text. When it is empty the render falls back to rekognition_description or to text built from the item's title, depending on the element, so an empty value here is not an empty alt attribute. | [optional] |
|
|
11
|
+
| **description_sha256** | **String** | SHA-256 of description (empty when there is none). Send it as current_sha256 when changing the description so a change made since you read it is not overwritten. | [optional] |
|
|
12
|
+
| **description_source** | **String** | Where the alt text comes from now. merchant when description is set, rekognition when only rekognition_description is, none otherwise. | [optional] |
|
|
11
13
|
| **dimensions** | **String** | Width x height in pixels, when the storage measured the file. | [optional] |
|
|
12
14
|
| **exclude_from_gallery** | **Boolean** | True when the storage marks this image as kept out of the item gallery. | [optional] |
|
|
13
15
|
| **filename** | **String** | The stored file's name. Empty when the slot is declared and nothing is attached. | [optional] |
|
|
16
|
+
| **merchant_item_multimedia_oid** | **Integer** | The stored image's id. Name it to change this image's description when it has no code. | [optional] |
|
|
17
|
+
| **rekognition_description** | **String** | The machine description image recognition produced for the stored image, if any. It is used only while description is empty, and a description written here or in the admin always takes its place. | [optional] |
|
|
14
18
|
| **type** | **String** | The media type the storage recorded. | [optional] |
|
|
15
19
|
| **view_url** | **String** | Where the stored image is served. Absent when nothing is attached to the slot. | [optional] |
|
|
16
20
|
|
|
@@ -24,9 +28,13 @@ instance = UltracartClient::SfvbItemMultimedia.new(
|
|
|
24
28
|
declared: null,
|
|
25
29
|
default: null,
|
|
26
30
|
description: null,
|
|
31
|
+
description_sha256: null,
|
|
32
|
+
description_source: null,
|
|
27
33
|
dimensions: null,
|
|
28
34
|
exclude_from_gallery: null,
|
|
29
35
|
filename: null,
|
|
36
|
+
merchant_item_multimedia_oid: null,
|
|
37
|
+
rekognition_description: null,
|
|
30
38
|
type: null,
|
|
31
39
|
view_url: null
|
|
32
40
|
)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemMultimediaDescriptionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The image code, the value an itemimage element's itemImageCode names. | [optional] |
|
|
8
|
+
| **current_sha256** | **String** | The description_sha256 you read. When it is sent and the description has changed since, nothing is written and the call fails with a version conflict. | [optional] |
|
|
9
|
+
| **default** | **Boolean** | The item's default image, which an itemimage element with no code renders. | [optional] |
|
|
10
|
+
| **description** | **String** | The new description, rendered as the image's alt text. An empty string clears it, so the image falls back to the machine description or the element's own fallback. Longer text is cut to 500 characters. | [optional] |
|
|
11
|
+
| **merchant_item_multimedia_oid** | **Integer** | The stored image's id, as an item read reports it. Name this, or one of code or default. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbItemMultimediaDescriptionRequest.new(
|
|
19
|
+
code: null,
|
|
20
|
+
current_sha256: null,
|
|
21
|
+
default: null,
|
|
22
|
+
description: null,
|
|
23
|
+
merchant_item_multimedia_oid: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
| **complete** | **Boolean** | True once the job has stopped, whether it succeeded or failed. | [optional] |
|
|
8
8
|
| **description** | **String** | Human readable description of the job. | [optional] |
|
|
9
9
|
| **error_message** | **String** | What to do next when the job did not produce a theme. The internal cause is not returned; it is recorded against the job id in the server log. | [optional] |
|
|
10
|
-
| **finished_dts** | **String** | When the job stopped. Null until it does. | [optional] |
|
|
10
|
+
| **finished_dts** | **String** | When the job stopped, ISO 8601 UTC. Null until it does. | [optional] |
|
|
11
11
|
| **job_id** | **Integer** | Job handle. Poll getSfvbThemeJob with this. | [optional] |
|
|
12
12
|
| **progress** | **Integer** | Percent complete, 0-100. | [optional] |
|
|
13
13
|
| **progress_description** | **String** | What the job is doing right now, for example 'Duplicating locale text'. | [optional] |
|
|
14
|
-
| **started_dts** | **String** | When the job started running. Null until it does. | [optional] |
|
|
14
|
+
| **started_dts** | **String** | When the job started running, ISO 8601 UTC. Null until it does. | [optional] |
|
|
15
15
|
| **status** | **String** | Raw job status. | [optional] |
|
|
16
|
-
| **submitted_dts** | **String** | When the job was queued. | [optional] |
|
|
16
|
+
| **submitted_dts** | **String** | When the job was queued, ISO 8601 UTC. | [optional] |
|
|
17
17
|
| **success** | **Boolean** | True only when the job finished successfully. Check complete first. | [optional] |
|
|
18
18
|
| **target_path** | **String** | Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. The theme oid itself is NOT returned, so once the job completes you list themes and match on this path. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending. | [optional] |
|
|
19
19
|
|
|
@@ -259,7 +259,7 @@ module UltracartClient
|
|
|
259
259
|
# Revoke this OAuth application.
|
|
260
260
|
# Revokes the OAuth application associated with the specified client_id and token.
|
|
261
261
|
# @param client_id [String] The OAuth application client_id.
|
|
262
|
-
# @param token [String] The OAuth access token that is to be revoked
|
|
262
|
+
# @param token [String] The OAuth access token or refresh token that is to be revoked.
|
|
263
263
|
# @param [Hash] opts the optional parameters
|
|
264
264
|
# @return [OauthRevokeSuccessResponse]
|
|
265
265
|
def oauth_revoke(client_id, token, opts = {})
|
|
@@ -270,7 +270,7 @@ module UltracartClient
|
|
|
270
270
|
# Revoke this OAuth application.
|
|
271
271
|
# Revokes the OAuth application associated with the specified client_id and token.
|
|
272
272
|
# @param client_id [String] The OAuth application client_id.
|
|
273
|
-
# @param token [String] The OAuth access token that is to be revoked
|
|
273
|
+
# @param token [String] The OAuth access token or refresh token that is to be revoked.
|
|
274
274
|
# @param [Hash] opts the optional parameters
|
|
275
275
|
# @return [Array<(OauthRevokeSuccessResponse, Integer, Hash)>] OauthRevokeSuccessResponse data, response status code and response headers
|
|
276
276
|
def oauth_revoke_with_http_info(client_id, token, opts = {})
|