ultracart_api 4.1.201 → 4.1.203

data/docs/SfvbSecretHandle.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbSecretHandle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **String** | When it stops being usable, ISO 8601 UTC. | [optional] |
+| **fingerprint** | **String** | The last few characters of the value, as a mask shows them, so the person can tell values apart.  Empty until entered. | [optional] |
+| **handle** | **String** | The handle.  Safe to log and keep in plans.  It works only for the sign-in that requested it. | [optional] |
+| **key** | **String** | The bulk key it is for, or empty. | [optional] |
+| **sink** | **String** | The secret field it can be written to. | [optional] |
+| **status** | **String** | pending (no value yet), ready, in_use (a write holds it), consumed, revoked or expired. | [optional] |
+| **target_id** | **String** | The object it can be written to, or empty when the request named none. | [optional] |
+| **uses_left** | **Integer** | Writes left.  Empty once the handle is gone. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretHandle.new(
+  expires_at: null,
+  fingerprint: null,
+  handle: null,
+  key: null,
+  sink: null,
+  status: null,
+  target_id: null,
+  uses_left: null
+)
+```
+

data/docs/SfvbSecretKind.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretKind
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Where the value comes from. | [optional] |
+| **format_hint** | **String** | What the value looks like.  The request page checks it as it is typed, and the server again. | [optional] |
+| **id** | **String** | The kind id. | [optional] |
+| **label** | **String** | What the person is told they are entering. | [optional] |
+| **mask_suffix** | **Integer** | How many trailing characters a mask shows at most. | [optional] |
+| **max_length** | **Integer** | Longest value accepted. | [optional] |
+| **min_length** | **Integer** | Shortest value accepted, after surrounding whitespace is removed. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKind.new(
+  description: null,
+  format_hint: null,
+  id: null,
+  label: null,
+  mask_suffix: null,
+  max_length: null,
+  min_length: null
+)
+```
+

data/docs/SfvbSecretKindsResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSecretKindsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kinds** | [**Array<SfvbSecretKind>**](SfvbSecretKind.md) | Every kind of secret this server collects. | [optional] |
+| **sinks** | [**Array<SfvbSecretSink>**](SfvbSecretSink.md) | Every secret field a handle can be written to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKindsResponse.new(
+  kinds: null,
+  sinks: null
+)
+```
+

data/docs/SfvbSecretRequest.md

@@ -0,0 +1,54 @@
+# UltracartClient::SfvbSecretRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
+| **delegated** | **Boolean** | True when the requester handed it to a colleague to fill in. | [optional] |
+| **description** | **String** | The sentence the person reads.  Written by the server, not the agent. | [optional] |
+| **expires_at** | **String** | When a pending request lapses, ISO 8601 UTC. | [optional] |
+| **expires_in_seconds** | **Integer** | Seconds until expires_at.  Zero once passed. | [optional] |
+| **fulfilled_at** | **String** | When the values were entered, ISO 8601 UTC. | [optional] |
+| **handle_count** | **Integer** | How many handles the request made. | [optional] |
+| **handles** | [**Array<SfvbSecretHandle>**](SfvbSecretHandle.md) | Every handle with its status.  Left out of the list endpoint; read one request for them. | [optional] |
+| **interval_seconds** | **Integer** | Poll no more often than this. | [optional] |
+| **keys** | **Array<String>** | The bulk keys, or empty. | [optional] |
+| **label** | **String** | The label the agent sent, as stored and shown. | [optional] |
+| **reason** | **String** | The reason the agent sent, as stored and shown. | [optional] |
+| **request_id** | **String** | The request id. | [optional] |
+| **request_url** | **String** | The page where the person enters the values.  Show it to them.  Never open or fill it in yourself. | [optional] |
+| **requires_totp** | **Boolean** | True when the person must enter a code from their authenticator app. | [optional] |
+| **sinks** | **Array<String>** | The secret fields being collected. | [optional] |
+| **status** | **String** | pending, fulfilled, cancelled or expired. | [optional] |
+| **target_id** | **String** | The object the values are for, or empty for a bulk request or an open one. | [optional] |
+| **user_code** | **String** | Short matching code.  Print it next to request_url so the person can check the page shows the same code. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequest.new(
+  created_at: null,
+  delegated: null,
+  description: null,
+  expires_at: null,
+  expires_in_seconds: null,
+  fulfilled_at: null,
+  handle_count: null,
+  handles: null,
+  interval_seconds: null,
+  keys: null,
+  label: null,
+  reason: null,
+  request_id: null,
+  request_url: null,
+  requires_totp: null,
+  sinks: null,
+  status: null,
+  target_id: null,
+  user_code: null
+)
+```
+

data/docs/SfvbSecretRequestCreate.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretRequestCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | **Array<String>** | Bulk.  One handle per key and sink, and each key is that handle's target, such as one sending domain per key.  At most 500 handles in all. | [optional] |
+| **label** | **String** | A short name the person sees, marked as unverified.  At most 120 characters. | [optional] |
+| **reason** | **String** | Why the agent needs it.  Shown to the person, marked as unverified.  At most 500 characters. | [optional] |
+| **sinks** | **Array<String>** | The secret fields to collect, by sink id.  GET secrets/kinds lists them.  All must take the same kind of target. | [optional] |
+| **target_id** | **String** | The object the values are for, such as a Twilio account uuid.  Required for sinks that need an authenticator code, unless keys names the targets.  Leave it out when keys is sent. | [optional] |
+| **ttl_seconds** | **Integer** | How long each handle stays usable once the values are entered.  60 to 86400, default 3600. | [optional] |
+| **uses** | **Integer** | How many writes each handle may make.  1 to 100, default 1. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequestCreate.new(
+  keys: null,
+  label: null,
+  reason: null,
+  sinks: null,
+  target_id: null,
+  ttl_seconds: null,
+  uses: null
+)
+```
+

data/docs/SfvbSecretRequestsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbSecretRequestsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requests** | [**Array<SfvbSecretRequest>**](SfvbSecretRequest.md) | This sign-in's secret requests from the last 24 hours, newest first, at most 50, without their handles. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequestsResponse.new(
+  requests: null
+)
+```
+

data/docs/SfvbSecretSink.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSecretSink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The sink id. | [optional] |
+| **kind** | **String** | The kind of value it holds. | [optional] |
+| **requires_totp** | **Boolean** | True when the person must enter a code from their authenticator app, and the request must name its target. | [optional] |
+| **target_type** | **String** | What a request names as its target_id or keys. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretSink.new(
+  id: null,
+  kind: null,
+  requires_totp: null,
+  target_type: null
+)
+```
+

data/lib/ultracart_api/api/oauth_api.rb

@@ -259,7 +259,7 @@ module UltracartClient
     # Revoke this OAuth application.
     # Revokes the OAuth application associated with the specified client_id and token. 
     # @param client_id [String] The OAuth application client_id.
-    # @param token [String] The OAuth access token that is to be revoked..
+    # @param token [String] The OAuth access token or refresh token that is to be revoked.
     # @param [Hash] opts the optional parameters
     # @return [OauthRevokeSuccessResponse]
     def oauth_revoke(client_id, token, opts = {})
@@ -270,7 +270,7 @@ module UltracartClient
     # Revoke this OAuth application.
     # Revokes the OAuth application associated with the specified client_id and token. 
     # @param client_id [String] The OAuth application client_id.
-    # @param token [String] The OAuth access token that is to be revoked..
+    # @param token [String] The OAuth access token or refresh token that is to be revoked.
     # @param [Hash] opts the optional parameters
     # @return [Array<(OauthRevokeSuccessResponse, Integer, Hash)>] OauthRevokeSuccessResponse data, response status code and response headers
     def oauth_revoke_with_http_info(client_id, token, opts = {})