ultracart_api 4.1.194 → 4.1.196
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/SfvbApi.md +220 -3
- data/docs/SfvbApproval.md +54 -0
- data/docs/SfvbApprovalCreateRequest.md +22 -0
- data/docs/SfvbApprovalParams.md +20 -0
- data/docs/SfvbApprovalsResponse.md +18 -0
- data/docs/SfvbTestOrdersResponse.md +1 -3
- data/lib/ultracart_api/api/sfvb_api.rb +264 -0
- data/lib/ultracart_api/models/sfvb_approval.rb +445 -0
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +273 -0
- data/lib/ultracart_api/models/sfvb_approval_params.rb +230 -0
- data/lib/ultracart_api/models/sfvb_approvals_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_test_orders_response.rb +2 -12
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5c7222ac0dd626297ff484ec56b6aa8c636da2dc9706563e11362fde60cb4a79
|
|
4
|
+
data.tar.gz: 0a346c7ee3b200f08c5a7d96be5d3dffe524d12e173bdb10c12407d391734b30
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4a41366e491f9ec56b4bbe74727527bd57e69537c983b4365295dece831cd87965b33fadf8edc33f7f681492692e69ac78c53b9051e92d6503a39d4f28c7629a
|
|
7
|
+
data.tar.gz: 4dfe0a02cf239c9f632ad5d3104e99f5349891d30456a918cd7d7ce3a4f9b3d86c7b3d6682bb926cd6e77874b4cd5c4f1c339bdc900ad3a72b029ba172e0a42f
|
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.196
|
|
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.196'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -486,6 +486,7 @@ Class | Method | HTTP request | Description
|
|
|
486
486
|
*UltracartClient::SfvbApi* | [**create_sfvb_library_entry**](docs/SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library
|
|
487
487
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
|
|
488
488
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
489
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_approval**](docs/SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request
|
|
489
490
|
*UltracartClient::SfvbApi* | [**delete_sfvb_blog_post**](docs/SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post
|
|
490
491
|
*UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
|
|
491
492
|
*UltracartClient::SfvbApi* | [**delete_sfvb_item_attribute**](docs/SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item
|
|
@@ -508,6 +509,8 @@ Class | Method | HTTP request | Description
|
|
|
508
509
|
*UltracartClient::SfvbApi* | [**enable_sfvb_i18n_language**](docs/SfvbApi.md#enable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable | Enable a language
|
|
509
510
|
*UltracartClient::SfvbApi* | [**end_sfvb_experiment**](docs/SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment
|
|
510
511
|
*UltracartClient::SfvbApi* | [**favorite_sfvb_library_entry**](docs/SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry
|
|
512
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_approval**](docs/SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request
|
|
513
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_approvals**](docs/SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests
|
|
511
514
|
*UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
|
|
512
515
|
*UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
|
|
513
516
|
*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
|
|
@@ -554,6 +557,7 @@ Class | Method | HTTP request | Description
|
|
|
554
557
|
*UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
|
|
555
558
|
*UltracartClient::SfvbApi* | [**ignore_sfvb_not_found_entry**](docs/SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path
|
|
556
559
|
*UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
|
|
560
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
|
|
557
561
|
*UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
|
|
558
562
|
*UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
|
|
559
563
|
*UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
|
|
@@ -1851,6 +1855,10 @@ Class | Method | HTTP request | Description
|
|
|
1851
1855
|
- [UltracartClient::ScreenRecordingUserProperty](docs/ScreenRecordingUserProperty.md)
|
|
1852
1856
|
- [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
|
|
1853
1857
|
- [UltracartClient::SelfConfig](docs/SelfConfig.md)
|
|
1858
|
+
- [UltracartClient::SfvbApproval](docs/SfvbApproval.md)
|
|
1859
|
+
- [UltracartClient::SfvbApprovalCreateRequest](docs/SfvbApprovalCreateRequest.md)
|
|
1860
|
+
- [UltracartClient::SfvbApprovalParams](docs/SfvbApprovalParams.md)
|
|
1861
|
+
- [UltracartClient::SfvbApprovalsResponse](docs/SfvbApprovalsResponse.md)
|
|
1854
1862
|
- [UltracartClient::SfvbBlogPost](docs/SfvbBlogPost.md)
|
|
1855
1863
|
- [UltracartClient::SfvbBlogPostDetail](docs/SfvbBlogPostDetail.md)
|
|
1856
1864
|
- [UltracartClient::SfvbBlogPostImage](docs/SfvbBlogPostImage.md)
|
|
@@ -2210,6 +2218,8 @@ Not every change is committed to every SDK.
|
|
|
2210
2218
|
|
|
2211
2219
|
| Version | Date | Comments |
|
|
2212
2220
|
| --: | :-: | --- |
|
|
2221
|
+
| 4.1.196 | 10/08/2026 | sfvb internal testing |
|
|
2222
|
+
| 4.1.195 | 10/07/2026 | sfvb internal testing |
|
|
2213
2223
|
| 4.1.194 | 10/07/2026 | sfvb internal testing |
|
|
2214
2224
|
| 4.1.193 | 10/06/2026 | sfvb internal testing |
|
|
2215
2225
|
| 4.1.192 | 10/06/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -14,6 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
14
14
|
| [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
|
|
15
15
|
| [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
|
|
16
16
|
| [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
|
|
17
|
+
| [**delete_sfvb_approval**](SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request |
|
|
17
18
|
| [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
|
|
18
19
|
| [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
|
|
19
20
|
| [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
|
|
@@ -36,6 +37,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
36
37
|
| [**enable_sfvb_i18n_language**](SfvbApi.md#enable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable | Enable a language |
|
|
37
38
|
| [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
|
|
38
39
|
| [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
|
|
40
|
+
| [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
|
|
41
|
+
| [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
|
|
39
42
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
40
43
|
| [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
|
|
41
44
|
| [**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 |
|
|
@@ -82,6 +85,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
82
85
|
| [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
|
|
83
86
|
| [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
|
|
84
87
|
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
88
|
+
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
85
89
|
| [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
|
|
86
90
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
87
91
|
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
@@ -696,9 +700,62 @@ end
|
|
|
696
700
|
- **Accept**: application/json
|
|
697
701
|
|
|
698
702
|
|
|
703
|
+
## delete_sfvb_approval
|
|
704
|
+
|
|
705
|
+
> delete_sfvb_approval(approval_id)
|
|
706
|
+
|
|
707
|
+
Cancel a pending approval request
|
|
708
|
+
|
|
709
|
+
Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
### Examples
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
(No example for this operation).
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
#### Using the delete_sfvb_approval_with_http_info variant
|
|
719
|
+
|
|
720
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
721
|
+
|
|
722
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_approval_with_http_info(approval_id)
|
|
723
|
+
|
|
724
|
+
```ruby
|
|
725
|
+
begin
|
|
726
|
+
# Cancel a pending approval request
|
|
727
|
+
data, status_code, headers = api_instance.delete_sfvb_approval_with_http_info(approval_id)
|
|
728
|
+
p status_code # => 2xx
|
|
729
|
+
p headers # => { ... }
|
|
730
|
+
p data # => nil
|
|
731
|
+
rescue UltracartClient::ApiError => e
|
|
732
|
+
puts "Error when calling SfvbApi->delete_sfvb_approval_with_http_info: #{e}"
|
|
733
|
+
end
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### Parameters
|
|
737
|
+
|
|
738
|
+
| Name | Type | Description | Notes |
|
|
739
|
+
| ---- | ---- | ----------- | ----- |
|
|
740
|
+
| **approval_id** | **String** | | |
|
|
741
|
+
|
|
742
|
+
### Return type
|
|
743
|
+
|
|
744
|
+
nil (empty response body)
|
|
745
|
+
|
|
746
|
+
### Authorization
|
|
747
|
+
|
|
748
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
749
|
+
|
|
750
|
+
### HTTP request headers
|
|
751
|
+
|
|
752
|
+
- **Content-Type**: Not defined
|
|
753
|
+
- **Accept**: application/json
|
|
754
|
+
|
|
755
|
+
|
|
699
756
|
## delete_sfvb_blog_post
|
|
700
757
|
|
|
701
|
-
> delete_sfvb_blog_post(storefront_oid, blog_post_oid)
|
|
758
|
+
> delete_sfvb_blog_post(storefront_oid, blog_post_oid, opts)
|
|
702
759
|
|
|
703
760
|
Delete a blog post
|
|
704
761
|
|
|
@@ -715,12 +772,12 @@ Takes the post off every page and deletes it. There is no undo. A post that is
|
|
|
715
772
|
|
|
716
773
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
717
774
|
|
|
718
|
-
> <Array(nil, Integer, Hash)> delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
|
|
775
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, opts)
|
|
719
776
|
|
|
720
777
|
```ruby
|
|
721
778
|
begin
|
|
722
779
|
# Delete a blog post
|
|
723
|
-
data, status_code, headers = api_instance.delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
|
|
780
|
+
data, status_code, headers = api_instance.delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, opts)
|
|
724
781
|
p status_code # => 2xx
|
|
725
782
|
p headers # => { ... }
|
|
726
783
|
p data # => nil
|
|
@@ -735,6 +792,7 @@ end
|
|
|
735
792
|
| ---- | ---- | ----------- | ----- |
|
|
736
793
|
| **storefront_oid** | **Integer** | | |
|
|
737
794
|
| **blog_post_oid** | **Integer** | | |
|
|
795
|
+
| **approval_id** | **String** | The approval_id of an approved blog_post.delete request for this post. See POST /sfvb/approvals. | [optional] |
|
|
738
796
|
|
|
739
797
|
### Return type
|
|
740
798
|
|
|
@@ -790,6 +848,7 @@ end
|
|
|
790
848
|
| **storefront_oid** | **Integer** | | |
|
|
791
849
|
| **if_match** | **String** | Content hash of the file being deleted. Required; 428 when absent, 412 when stale. | |
|
|
792
850
|
| **path** | **String** | | [optional] |
|
|
851
|
+
| **approval_id** | **String** | The approval_id of an approved file.delete request for this exact path. See POST /sfvb/approvals. | [optional] |
|
|
793
852
|
|
|
794
853
|
### Return type
|
|
795
854
|
|
|
@@ -1902,6 +1961,110 @@ nil (empty response body)
|
|
|
1902
1961
|
- **Accept**: application/json
|
|
1903
1962
|
|
|
1904
1963
|
|
|
1964
|
+
## get_sfvb_approval
|
|
1965
|
+
|
|
1966
|
+
> <SfvbApproval> get_sfvb_approval(approval_id)
|
|
1967
|
+
|
|
1968
|
+
Read one approval request
|
|
1969
|
+
|
|
1970
|
+
Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
### Examples
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
(No example for this operation).
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
#### Using the get_sfvb_approval_with_http_info variant
|
|
1980
|
+
|
|
1981
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1982
|
+
|
|
1983
|
+
> <Array(<SfvbApproval>, Integer, Hash)> get_sfvb_approval_with_http_info(approval_id)
|
|
1984
|
+
|
|
1985
|
+
```ruby
|
|
1986
|
+
begin
|
|
1987
|
+
# Read one approval request
|
|
1988
|
+
data, status_code, headers = api_instance.get_sfvb_approval_with_http_info(approval_id)
|
|
1989
|
+
p status_code # => 2xx
|
|
1990
|
+
p headers # => { ... }
|
|
1991
|
+
p data # => <SfvbApproval>
|
|
1992
|
+
rescue UltracartClient::ApiError => e
|
|
1993
|
+
puts "Error when calling SfvbApi->get_sfvb_approval_with_http_info: #{e}"
|
|
1994
|
+
end
|
|
1995
|
+
```
|
|
1996
|
+
|
|
1997
|
+
### Parameters
|
|
1998
|
+
|
|
1999
|
+
| Name | Type | Description | Notes |
|
|
2000
|
+
| ---- | ---- | ----------- | ----- |
|
|
2001
|
+
| **approval_id** | **String** | | |
|
|
2002
|
+
|
|
2003
|
+
### Return type
|
|
2004
|
+
|
|
2005
|
+
[**SfvbApproval**](SfvbApproval.md)
|
|
2006
|
+
|
|
2007
|
+
### Authorization
|
|
2008
|
+
|
|
2009
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2010
|
+
|
|
2011
|
+
### HTTP request headers
|
|
2012
|
+
|
|
2013
|
+
- **Content-Type**: Not defined
|
|
2014
|
+
- **Accept**: application/json
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
## get_sfvb_approvals
|
|
2018
|
+
|
|
2019
|
+
> <SfvbApprovalsResponse> get_sfvb_approvals
|
|
2020
|
+
|
|
2021
|
+
List this sign-in's approval requests
|
|
2022
|
+
|
|
2023
|
+
Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
### Examples
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
(No example for this operation).
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
#### Using the get_sfvb_approvals_with_http_info variant
|
|
2033
|
+
|
|
2034
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2035
|
+
|
|
2036
|
+
> <Array(<SfvbApprovalsResponse>, Integer, Hash)> get_sfvb_approvals_with_http_info
|
|
2037
|
+
|
|
2038
|
+
```ruby
|
|
2039
|
+
begin
|
|
2040
|
+
# List this sign-in's approval requests
|
|
2041
|
+
data, status_code, headers = api_instance.get_sfvb_approvals_with_http_info
|
|
2042
|
+
p status_code # => 2xx
|
|
2043
|
+
p headers # => { ... }
|
|
2044
|
+
p data # => <SfvbApprovalsResponse>
|
|
2045
|
+
rescue UltracartClient::ApiError => e
|
|
2046
|
+
puts "Error when calling SfvbApi->get_sfvb_approvals_with_http_info: #{e}"
|
|
2047
|
+
end
|
|
2048
|
+
```
|
|
2049
|
+
|
|
2050
|
+
### Parameters
|
|
2051
|
+
|
|
2052
|
+
This endpoint does not need any parameter.
|
|
2053
|
+
|
|
2054
|
+
### Return type
|
|
2055
|
+
|
|
2056
|
+
[**SfvbApprovalsResponse**](SfvbApprovalsResponse.md)
|
|
2057
|
+
|
|
2058
|
+
### Authorization
|
|
2059
|
+
|
|
2060
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2061
|
+
|
|
2062
|
+
### HTTP request headers
|
|
2063
|
+
|
|
2064
|
+
- **Content-Type**: Not defined
|
|
2065
|
+
- **Accept**: application/json
|
|
2066
|
+
|
|
2067
|
+
|
|
1905
2068
|
## get_sfvb_blog_post
|
|
1906
2069
|
|
|
1907
2070
|
> <SfvbBlogPostDetail> get_sfvb_blog_post(storefront_oid, blog_post_oid)
|
|
@@ -4399,6 +4562,60 @@ end
|
|
|
4399
4562
|
- **Accept**: application/json
|
|
4400
4563
|
|
|
4401
4564
|
|
|
4565
|
+
## insert_sfvb_approval
|
|
4566
|
+
|
|
4567
|
+
> insert_sfvb_approval(approval_request, opts)
|
|
4568
|
+
|
|
4569
|
+
Request a human approval
|
|
4570
|
+
|
|
4571
|
+
Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
|
|
4572
|
+
|
|
4573
|
+
|
|
4574
|
+
### Examples
|
|
4575
|
+
|
|
4576
|
+
|
|
4577
|
+
(No example for this operation).
|
|
4578
|
+
|
|
4579
|
+
|
|
4580
|
+
#### Using the insert_sfvb_approval_with_http_info variant
|
|
4581
|
+
|
|
4582
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
4583
|
+
|
|
4584
|
+
> <Array(nil, Integer, Hash)> insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
4585
|
+
|
|
4586
|
+
```ruby
|
|
4587
|
+
begin
|
|
4588
|
+
# Request a human approval
|
|
4589
|
+
data, status_code, headers = api_instance.insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
4590
|
+
p status_code # => 2xx
|
|
4591
|
+
p headers # => { ... }
|
|
4592
|
+
p data # => nil
|
|
4593
|
+
rescue UltracartClient::ApiError => e
|
|
4594
|
+
puts "Error when calling SfvbApi->insert_sfvb_approval_with_http_info: #{e}"
|
|
4595
|
+
end
|
|
4596
|
+
```
|
|
4597
|
+
|
|
4598
|
+
### Parameters
|
|
4599
|
+
|
|
4600
|
+
| Name | Type | Description | Notes |
|
|
4601
|
+
| ---- | ---- | ----------- | ----- |
|
|
4602
|
+
| **approval_request** | [**SfvbApprovalCreateRequest**](SfvbApprovalCreateRequest.md) | The request | |
|
|
4603
|
+
| **storefront_oid** | **Integer** | The storefront the action runs on. Required for storefront actions, left out for account-wide ones. | [optional] |
|
|
4604
|
+
|
|
4605
|
+
### Return type
|
|
4606
|
+
|
|
4607
|
+
nil (empty response body)
|
|
4608
|
+
|
|
4609
|
+
### Authorization
|
|
4610
|
+
|
|
4611
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4612
|
+
|
|
4613
|
+
### HTTP request headers
|
|
4614
|
+
|
|
4615
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4616
|
+
- **Accept**: application/json
|
|
4617
|
+
|
|
4618
|
+
|
|
4402
4619
|
## insert_sfvb_blog_post
|
|
4403
4620
|
|
|
4404
4621
|
> <SfvbBlogPostDetail> insert_sfvb_blog_post(storefront_oid, blog_post_request)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# UltracartClient::SfvbApproval
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | The gated action. | [optional] |
|
|
8
|
+
| **approval_id** | **String** | Send this as the Approval-Id header on the gated call once status is approved. | [optional] |
|
|
9
|
+
| **approval_url** | **String** | The page where the person approves or denies. Show it to them. Never open or fill it in yourself. | [optional] |
|
|
10
|
+
| **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
|
|
11
|
+
| **description** | **String** | The sentence the person reads before approving. Written by the server, not the agent. | [optional] |
|
|
12
|
+
| **expires_at** | **String** | When this approval stops being usable, ISO 8601 UTC. For a pending request, when it lapses undecided. For an approved one, when it must have been used by. | [optional] |
|
|
13
|
+
| **expires_in_seconds** | **Integer** | Seconds until expires_at. Zero once passed. | [optional] |
|
|
14
|
+
| **fresh_code_required** | **Boolean** | True when the person must enter a new 2FA code for this request even inside an approval session. | [optional] |
|
|
15
|
+
| **interval_seconds** | **Integer** | Poll no more often than this. | [optional] |
|
|
16
|
+
| **outcome** | **String** | Once used, succeeded or failed. Used with no outcome means the result is unknown. Check the target and never send the call again with this approval. | [optional] |
|
|
17
|
+
| **outcome_code** | **String** | The error code the gated call failed with. | [optional] |
|
|
18
|
+
| **outcome_http_status** | **Integer** | The HTTP status the gated call answered with. | [optional] |
|
|
19
|
+
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
20
|
+
| **reason** | **String** | The reason the agent sent, as stored and shown (cleaned and capped). | [optional] |
|
|
21
|
+
| **scope** | **String** | Where the action applies. The storefront host name, or account for account-wide actions. | [optional] |
|
|
22
|
+
| **status** | **String** | pending, approved, denied, cancelled, expired or used. Only approved may be sent with the gated call. | [optional] |
|
|
23
|
+
| **storefront_oid** | **Integer** | The storefront the action runs on. Absent for account-wide actions. | [optional] |
|
|
24
|
+
| **used_at** | **String** | When the gated call used this approval, ISO 8601 UTC. | [optional] |
|
|
25
|
+
| **user_code** | **String** | Short matching code. Print it next to approval_url so the person can check the page shows the same code. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'ultracart_api'
|
|
31
|
+
|
|
32
|
+
instance = UltracartClient::SfvbApproval.new(
|
|
33
|
+
action: null,
|
|
34
|
+
approval_id: null,
|
|
35
|
+
approval_url: null,
|
|
36
|
+
created_at: null,
|
|
37
|
+
description: null,
|
|
38
|
+
expires_at: null,
|
|
39
|
+
expires_in_seconds: null,
|
|
40
|
+
fresh_code_required: null,
|
|
41
|
+
interval_seconds: null,
|
|
42
|
+
outcome: null,
|
|
43
|
+
outcome_code: null,
|
|
44
|
+
outcome_http_status: null,
|
|
45
|
+
params: null,
|
|
46
|
+
reason: null,
|
|
47
|
+
scope: null,
|
|
48
|
+
status: null,
|
|
49
|
+
storefront_oid: null,
|
|
50
|
+
used_at: null,
|
|
51
|
+
user_code: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalCreateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | The gated action to approve. | [optional] |
|
|
8
|
+
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
9
|
+
| **reason** | **String** | Why the agent wants to do this, in a sentence. Shown to the person as unverified text, capped at 500 characters. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
17
|
+
action: null,
|
|
18
|
+
params: null,
|
|
19
|
+
reason: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
|
|
8
|
+
| **path** | **String** | The file path, for file.delete. Exactly as the delete call will send it. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbApprovalParams.new(
|
|
16
|
+
blog_post_oid: null,
|
|
17
|
+
path: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **approvals** | [**Array<SfvbApproval>**](SfvbApproval.md) | This sign-in's requests from the last 24 hours, newest first, at most 50. Pending ones are always within that window, because a request expires after 10 minutes. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbApprovalsResponse.new(
|
|
15
|
+
approvals: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **hint** | **String** | Present when nothing matched.
|
|
8
|
-
| **searched_days** | **Integer** | How many days back were searched, 7, 30 or 90, widening until enough test orders were found. | [optional] |
|
|
7
|
+
| **hint** | **String** | Present when nothing matched. | [optional] |
|
|
9
8
|
| **test_orders** | [**Array<SfvbTestOrder>**](SfvbTestOrder.md) | Test orders, newest first. Only orders marked as test orders are ever listed. | [optional] |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'ultracart_api'
|
|
|
15
14
|
|
|
16
15
|
instance = UltracartClient::SfvbTestOrdersResponse.new(
|
|
17
16
|
hint: null,
|
|
18
|
-
searched_days: null,
|
|
19
17
|
test_orders: null
|
|
20
18
|
)
|
|
21
19
|
```
|