api-sdk-rb 1.11.66

data/docs/UsersApi.md

@@ -0,0 +1,881 @@
+# ApiSdkRb::UsersApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_personal_workspace_domain_0**](UsersApi.md#add_personal_workspace_domain_0) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets |
+| [**create_user_api_key_0**](UsersApi.md#create_user_api_key_0) | **POST** /users/{id}/keys | Create an API key |
+| [**delete_personal_workspace_domain_0**](UsersApi.md#delete_personal_workspace_domain_0) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets |
+| [**delete_user_api_key_0**](UsersApi.md#delete_user_api_key_0) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key |
+| [**get_personal_workspace_domains_0**](UsersApi.md#get_personal_workspace_domains_0) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets |
+| [**get_user_adapter_connections_0**](UsersApi.md#get_user_adapter_connections_0) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected |
+| [**get_user_api_key_usage_logs_0**](UsersApi.md#get_user_api_key_usage_logs_0) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for |
+| [**get_user_api_keys_0**](UsersApi.md#get_user_api_keys_0) | **GET** /users/{id}/keys | List the API keys of an account |
+| [**remove_user_adapter_connection_0**](UsersApi.md#remove_user_adapter_connection_0) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account |
+| [**set_user_adapter_connection_0**](UsersApi.md#set_user_adapter_connection_0) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account |
+| [**update_personal_workspace_domain_0**](UsersApi.md#update_personal_workspace_domain_0) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list |
+| [**update_user_api_key_0**](UsersApi.md#update_user_api_key_0) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on |
+
+
+## add_personal_workspace_domain_0
+
+> <PersonalWorkspaceDomainResultResponse> add_personal_workspace_domain_0(id, add_domain_request)
+
+Allow a website to show your widgets
+
+Adds a website to an account's own list. Give a website name such as `example.com`, or `*.example.com` for a website and all of its subdomains. A scheme, a port, a path, capital letters and a leading `www.` are dropped, so `https://www.Example.com/shop` is kept as `example.com`, and `example.com` covers `www.example.com` too. Something that is not a website name is refused, not stored. Until the first website is added nothing is restricted, and a widget can be shown anywhere. Once the list has one, a widget of the account is shown on the listed websites (and on Widgetic's own) and nowhere else. A page on your own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed, so there is nothing to add to test locally. So is the website where a partner your account administers integrates Widgetic, with every subdomain of it (`platformDomain` in the answer of `GET /partners/mine`), so there is nothing to add for it either and a list can never lock it out. A change can take about 15 seconds to reach every server. The list is a safeguard against other websites showing your widgets in a visitor's browser. It is not access control: anyone who knows a widget's id can still fetch its published content with a plain request that names no website. There is no limit on the list of an account that administers a partner, so a partner can add the website of each of its customers as they publish on their own domain, one call each. Any other account can list at most 50 websites, and the 51st is answered with a 409 (`BUSINESS_STATE_CONFLICT`). A wildcard such as `*.example.com` counts as one website, not one per subdomain, so use it instead of listing each subdomain. A page that frames a widget can name only so many websites to the browser (about fifty of ordinary length). Past that, the browser no longer checks the list for that page; the lookup that the Embed SDK makes for the widget still refuses every website that is not on the list.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belongs to. For your own, your own user id
+add_domain_request = ApiSdkRb::AddDomainRequest.new({domain: 'example.com'}) # AddDomainRequest | 
+
+begin
+  # Allow a website to show your widgets
+  result = api_instance.add_personal_workspace_domain_0(id, add_domain_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->add_personal_workspace_domain_0: #{e}"
+end
+```
+
+#### Using the add_personal_workspace_domain_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> add_personal_workspace_domain_0_with_http_info(id, add_domain_request)
+
+```ruby
+begin
+  # Allow a website to show your widgets
+  data, status_code, headers = api_instance.add_personal_workspace_domain_0_with_http_info(id, add_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonalWorkspaceDomainResultResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->add_personal_workspace_domain_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the list belongs to. For your own, your own user id |  |
+| **add_domain_request** | [**AddDomainRequest**](AddDomainRequest.md) |  |  |
+
+### Return type
+
+[**PersonalWorkspaceDomainResultResponse**](PersonalWorkspaceDomainResultResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_user_api_key_0
+
+> <CreatedUserApiKeyResponse> create_user_api_key_0(id, idempotency_key, create_user_api_key_request)
+
+Create an API key
+
+Makes a new API key for an account and returns its secret in `key`. That is the only time the secret is shown: Widgetic keeps a hash, so a key that was not stored cannot be recovered, only replaced. To rotate a key, make the new one, switch the integration over to it, then delete the old one. Only a person signed in on widgetic.com can make a key: a request made with an API key, or with an SDK token, is refused with 403. That way a leaked key cannot be used to make a second one that survives its revocation. Make keys from the dashboard; a key can still list, rename, switch off and delete keys. An `Idempotency-Key` header is required (8 to 50 characters: letters, digits, `-` and `_`). A retry with the same header and the same body returns the same answer instead of making a second key, and the same header with a different body is refused with 422. Make keys one at a time: two requests for the same account that run at the same moment can overwrite each other. A key can be limited to what it needs. Send a `preset` (`read_only`, `content` or `full_access`) or a list of `scopes`, never both. Send neither for a key that can do everything its owner can, as every key made before scopes existed. A limited key is refused with 403 and the code `API_KEY_SCOPE_MISSING` on anything outside its scopes, so a key held by a build server or by a partner's backend can be given only the part of the API it uses. The scopes of a key are fixed when it is made: to widen one, make a new key and delete the old one. A limited key cannot make, change or delete keys, exchange tokens or reach the administration routes. The list of scopes is in the `ApiKeyScope` schema. Accounts with API access (Solo, Teams and partner accounts) have no limit on how many keys they hold. An account on a plan without API access cannot make one (a partner account is not asked about a plan).
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the key is for. For your own, your own user id
+idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
+create_user_api_key_request = ApiSdkRb::CreateUserApiKeyRequest.new({name: 'Production'}) # CreateUserApiKeyRequest | 
+
+begin
+  # Create an API key
+  result = api_instance.create_user_api_key_0(id, idempotency_key, create_user_api_key_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->create_user_api_key_0: #{e}"
+end
+```
+
+#### Using the create_user_api_key_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatedUserApiKeyResponse>, Integer, Hash)> create_user_api_key_0_with_http_info(id, idempotency_key, create_user_api_key_request)
+
+```ruby
+begin
+  # Create an API key
+  data, status_code, headers = api_instance.create_user_api_key_0_with_http_info(id, idempotency_key, create_user_api_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatedUserApiKeyResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->create_user_api_key_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the key is for. For your own, your own user id |  |
+| **idempotency_key** | **String** | Required: a call without it is refused with &#x60;400&#x60;. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, &#x60;-&#x60; and &#x60;_&#x60;. Send the same key again when you retry (after a timeout, a dropped connection or a &#x60;5xx&#x60;) and the call is carried out once: the retry gets the first answer back, marked &#x60;X-Idempotency-Cached: true&#x60;. The same key with a different body is refused with &#x60;422&#x60;, and a retry that arrives while the first call is still running with &#x60;409&#x60; (see &#x60;Retry-After&#x60;). |  |
+| **create_user_api_key_request** | [**CreateUserApiKeyRequest**](CreateUserApiKeyRequest.md) |  |  |
+
+### Return type
+
+[**CreatedUserApiKeyResponse**](CreatedUserApiKeyResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_personal_workspace_domain_0
+
+> <DeletePersonalWorkspaceDomainResponse> delete_personal_workspace_domain_0(id, domain_id)
+
+Stop allowing a website to show your widgets
+
+Removes one entry from an account's own list. When it was the last one, nothing is restricted any more and a widget can be shown anywhere again. A change can take about 15 seconds to reach every server.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belongs to. For your own, your own user id
+domain_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `id` of the entry, as the list shows it
+
+begin
+  # Stop allowing a website to show your widgets
+  result = api_instance.delete_personal_workspace_domain_0(id, domain_id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->delete_personal_workspace_domain_0: #{e}"
+end
+```
+
+#### Using the delete_personal_workspace_domain_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletePersonalWorkspaceDomainResponse>, Integer, Hash)> delete_personal_workspace_domain_0_with_http_info(id, domain_id)
+
+```ruby
+begin
+  # Stop allowing a website to show your widgets
+  data, status_code, headers = api_instance.delete_personal_workspace_domain_0_with_http_info(id, domain_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletePersonalWorkspaceDomainResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->delete_personal_workspace_domain_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the list belongs to. For your own, your own user id |  |
+| **domain_id** | **String** | The &#x60;id&#x60; of the entry, as the list shows it |  |
+
+### Return type
+
+[**DeletePersonalWorkspaceDomainResponse**](DeletePersonalWorkspaceDomainResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_user_api_key_0
+
+> <DeleteUserApiKeyResponse> delete_user_api_key_0(id, key_id)
+
+Delete an API key
+
+Deletes a key and the record of what it was used for. The key stops working at once on the server that took the request and within a minute on the others, and cannot be brought back: make a new one instead. To stop a key without losing it, switch it off with `updateUserApiKey`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the key belongs to
+key_id = 'key_id_example' # String | The `keyId` of the key, as the list shows it
+
+begin
+  # Delete an API key
+  result = api_instance.delete_user_api_key_0(id, key_id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->delete_user_api_key_0: #{e}"
+end
+```
+
+#### Using the delete_user_api_key_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteUserApiKeyResponse>, Integer, Hash)> delete_user_api_key_0_with_http_info(id, key_id)
+
+```ruby
+begin
+  # Delete an API key
+  data, status_code, headers = api_instance.delete_user_api_key_0_with_http_info(id, key_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteUserApiKeyResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->delete_user_api_key_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the key belongs to |  |
+| **key_id** | **String** | The &#x60;keyId&#x60; of the key, as the list shows it |  |
+
+### Return type
+
+[**DeleteUserApiKeyResponse**](DeleteUserApiKeyResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_personal_workspace_domains_0
+
+> <GetPersonalWorkspaceDomains200Response> get_personal_workspace_domains_0(id)
+
+List the websites allowed to show your widgets
+
+Lists the websites on an account's own list, newest first. It is the list Widgetic checks when a widget of the account is embedded: when it holds at least one website, the widget is shown on those websites (and on Widgetic's own) and nowhere else; when it is empty, the widget can be shown anywhere. If the account administers a partner, the websites set on the partner record by Widgetic are added to them. Widgets that belong to an organization use the organization's list instead. The answer holds the whole list, however long it is: a partner's list has no limit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belongs to. For your own, your own user id
+
+begin
+  # List the websites allowed to show your widgets
+  result = api_instance.get_personal_workspace_domains_0(id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_personal_workspace_domains_0: #{e}"
+end
+```
+
+#### Using the get_personal_workspace_domains_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPersonalWorkspaceDomains200Response>, Integer, Hash)> get_personal_workspace_domains_0_with_http_info(id)
+
+```ruby
+begin
+  # List the websites allowed to show your widgets
+  data, status_code, headers = api_instance.get_personal_workspace_domains_0_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPersonalWorkspaceDomains200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_personal_workspace_domains_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the list belongs to. For your own, your own user id |  |
+
+### Return type
+
+[**GetPersonalWorkspaceDomains200Response**](GetPersonalWorkspaceDomains200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_adapter_connections_0
+
+> <GetUserAdapterConnections200Response> get_user_adapter_connections_0(user_id)
+
+See which adapter keys an account has connected
+
+Widget adapters are capabilities a widget can use, and some of them act through a service the owner has an account with: an adapter that sends email needs the owner's email provider key, one that sends texts needs the owner's SMS provider key. This lists every key an adapter takes from an owner and whether this account has connected it, so a settings page can show what is missing.  An empty list means no adapter takes a key from an owner at the moment. The list never contains a key: only whether one is connected and when it was last set.  Connect a key with `setUserAdapterConnection`; take it away with `removeUserAdapterConnection`. The widgets of customers a partner manages use the partner's keys instead (`getPartnerAdapterConnections`).  The caller must be the account itself (an API key of that account works, with the `account:read` scope), or a Widgetic administrator. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account whose adapter keys to list. For your own, your own user id
+
+begin
+  # See which adapter keys an account has connected
+  result = api_instance.get_user_adapter_connections_0(user_id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_adapter_connections_0: #{e}"
+end
+```
+
+#### Using the get_user_adapter_connections_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserAdapterConnections200Response>, Integer, Hash)> get_user_adapter_connections_0_with_http_info(user_id)
+
+```ruby
+begin
+  # See which adapter keys an account has connected
+  data, status_code, headers = api_instance.get_user_adapter_connections_0_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserAdapterConnections200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_adapter_connections_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The account whose adapter keys to list. For your own, your own user id |  |
+
+### Return type
+
+[**GetUserAdapterConnections200Response**](GetUserAdapterConnections200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_api_key_usage_logs_0
+
+> <GetUserApiKeyUsageLogsResponse> get_user_api_key_usage_logs_0(id, key_id, opts)
+
+Read what an API key was used for
+
+Lists the calls made with one key, newest first: when, which path and method, and the status each ended with. Use it to see whether a key is still in use before deleting it, or to see what a key that should not be in use has been doing.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the key belongs to
+key_id = 'key_id_example' # String | The `keyId` of the key, as the list shows it
+opts = {
+  limit: 56 # Integer | How many calls to return, newest first
+}
+
+begin
+  # Read what an API key was used for
+  result = api_instance.get_user_api_key_usage_logs_0(id, key_id, opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_api_key_usage_logs_0: #{e}"
+end
+```
+
+#### Using the get_user_api_key_usage_logs_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserApiKeyUsageLogsResponse>, Integer, Hash)> get_user_api_key_usage_logs_0_with_http_info(id, key_id, opts)
+
+```ruby
+begin
+  # Read what an API key was used for
+  data, status_code, headers = api_instance.get_user_api_key_usage_logs_0_with_http_info(id, key_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserApiKeyUsageLogsResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_api_key_usage_logs_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the key belongs to |  |
+| **key_id** | **String** | The &#x60;keyId&#x60; of the key, as the list shows it |  |
+| **limit** | **Integer** | How many calls to return, newest first | [optional][default to 500] |
+
+### Return type
+
+[**GetUserApiKeyUsageLogsResponse**](GetUserApiKeyUsageLogsResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_api_keys_0
+
+> <GetUserApiKeys200Response> get_user_api_keys_0(id)
+
+List the API keys of an account
+
+Lists the API keys of an account, in the order they were made: name, the first characters of the key, when it was made, when it expires, when it was last used, whether it is switched on and what it is limited to (`scopes` and `preset`). The secret of a key is never part of the list. A caller can list its own account's keys; Widgetic staff can list any account's.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the keys belong to. For your own keys, your own user id
+
+begin
+  # List the API keys of an account
+  result = api_instance.get_user_api_keys_0(id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_api_keys_0: #{e}"
+end
+```
+
+#### Using the get_user_api_keys_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserApiKeys200Response>, Integer, Hash)> get_user_api_keys_0_with_http_info(id)
+
+```ruby
+begin
+  # List the API keys of an account
+  data, status_code, headers = api_instance.get_user_api_keys_0_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserApiKeys200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->get_user_api_keys_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the keys belong to. For your own keys, your own user id |  |
+
+### Return type
+
+[**GetUserApiKeys200Response**](GetUserApiKeys200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_user_adapter_connection_0
+
+> <RemoveUserAdapterConnection200Response> remove_user_adapter_connection_0(user_id, adapter_id, credential_key)
+
+Remove an adapter key from an account
+
+Removes a key an adapter was given. The adapter stops working for the widgets that need it: their visitors are told the feature is unavailable. Nothing else of the widgets changes, and connecting a key again brings them back.  Removing a key that is not connected answers 200 with `removed: false`: the state asked for is the state it is in. A key of an adapter that has since been retired from the catalog can still be removed.  This needs an API key with full access. The caller must be the account itself or a Widgetic administrator. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account that keeps the key. For your own, your own user id
+adapter_id = 'adapter_id_example' # String | The adapter the key is for
+credential_key = 'credential_key_example' # String | The key's name within the adapter
+
+begin
+  # Remove an adapter key from an account
+  result = api_instance.remove_user_adapter_connection_0(user_id, adapter_id, credential_key)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->remove_user_adapter_connection_0: #{e}"
+end
+```
+
+#### Using the remove_user_adapter_connection_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoveUserAdapterConnection200Response>, Integer, Hash)> remove_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key)
+
+```ruby
+begin
+  # Remove an adapter key from an account
+  data, status_code, headers = api_instance.remove_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoveUserAdapterConnection200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->remove_user_adapter_connection_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The account that keeps the key. For your own, your own user id |  |
+| **adapter_id** | **String** | The adapter the key is for |  |
+| **credential_key** | **String** | The key&#39;s name within the adapter |  |
+
+### Return type
+
+[**RemoveUserAdapterConnection200Response**](RemoveUserAdapterConnection200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_user_adapter_connection_0
+
+> <SetUserAdapterConnection200Response> set_user_adapter_connection_0(user_id, adapter_id, credential_key, set_adapter_connection_request)
+
+Connect an adapter key to an account
+
+Gives an adapter the key it needs to act through a service you have an account with, for the widgets you made. Take the `adapterId` and `credentialKey` from `getUserAdapterConnections`. Saving a key that is already connected replaces it.  **What Widgetic does with it.** The key is stored encrypted, bound to this account, this adapter and this credential, so that a stored value cannot be moved to another. It is never returned, never logged and never shown to a visitor of a widget. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on your behalf, and discards it. To cut that off, remove the key here, or revoke it with the provider.  **What is checked.** That the adapter exists and takes this credential, that an owner may keep it (some are for a partner only) and that the text is one line of at most 2048 characters. Whether the provider accepts the key is not checked here: it shows the first time a widget uses it, and the widget tells its owner.  A widget whose adapter has no key connected is not charged and does not run that adapter: its visitors are told the feature is unavailable, and the owner is told once a day what to connect.  This needs an API key with full access. The caller must be the account itself or a Widgetic administrator. A retry is harmless: saving the same key twice only refreshes when it was set. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account that keeps the key. For your own, your own user id
+adapter_id = 'adapter_id_example' # String | The adapter the key is for
+credential_key = 'credential_key_example' # String | The key's name within the adapter
+set_adapter_connection_request = ApiSdkRb::SetAdapterConnectionRequest.new({credential: 'YOUR_PROVIDER_KEY'}) # SetAdapterConnectionRequest | 
+
+begin
+  # Connect an adapter key to an account
+  result = api_instance.set_user_adapter_connection_0(user_id, adapter_id, credential_key, set_adapter_connection_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->set_user_adapter_connection_0: #{e}"
+end
+```
+
+#### Using the set_user_adapter_connection_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SetUserAdapterConnection200Response>, Integer, Hash)> set_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key, set_adapter_connection_request)
+
+```ruby
+begin
+  # Connect an adapter key to an account
+  data, status_code, headers = api_instance.set_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key, set_adapter_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetUserAdapterConnection200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->set_user_adapter_connection_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The account that keeps the key. For your own, your own user id |  |
+| **adapter_id** | **String** | The adapter the key is for |  |
+| **credential_key** | **String** | The key&#39;s name within the adapter |  |
+| **set_adapter_connection_request** | [**SetAdapterConnectionRequest**](SetAdapterConnectionRequest.md) |  |  |
+
+### Return type
+
+[**SetUserAdapterConnection200Response**](SetUserAdapterConnection200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_personal_workspace_domain_0
+
+> <PersonalWorkspaceDomainResultResponse> update_personal_workspace_domain_0(id, domain_id, update_domain_request)
+
+Change a website on your list
+
+Replaces the website of one entry on an account's own list. The same rules apply as when adding one (`addPersonalWorkspaceDomain`): a website name such as `example.com` or `*.example.com`, kept in its cleaned form, and refused when it is not a website name or is already on the list.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belongs to. For your own, your own user id
+domain_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `id` of the entry, as the list shows it
+update_domain_request = ApiSdkRb::UpdateDomainRequest.new({domain: 'example.com'}) # UpdateDomainRequest | 
+
+begin
+  # Change a website on your list
+  result = api_instance.update_personal_workspace_domain_0(id, domain_id, update_domain_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->update_personal_workspace_domain_0: #{e}"
+end
+```
+
+#### Using the update_personal_workspace_domain_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> update_personal_workspace_domain_0_with_http_info(id, domain_id, update_domain_request)
+
+```ruby
+begin
+  # Change a website on your list
+  data, status_code, headers = api_instance.update_personal_workspace_domain_0_with_http_info(id, domain_id, update_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonalWorkspaceDomainResultResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->update_personal_workspace_domain_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the list belongs to. For your own, your own user id |  |
+| **domain_id** | **String** | The &#x60;id&#x60; of the entry, as the list shows it |  |
+| **update_domain_request** | [**UpdateDomainRequest**](UpdateDomainRequest.md) |  |  |
+
+### Return type
+
+[**PersonalWorkspaceDomainResultResponse**](PersonalWorkspaceDomainResultResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_user_api_key_0
+
+> <UserApiKeyResponse> update_user_api_key_0(id, key_id, update_user_api_key_request)
+
+Rename an API key, or switch it off or on
+
+Renames a key, or switches it off (`isActive: false`) or back on. A key that is switched off is refused at once by the server that took the request and within a minute by the others, and can be switched on again; deleting is for a key that is not coming back. The secret, the expiry and the scopes of a key cannot be changed. Only a key with full access can make these requests: a key limited to some scopes is refused with 403 and the code `API_KEY_SCOPE_MISSING`. Renaming and switching off can be done with an API key. Switching a key on needs a person signed in on widgetic.com: a request that asks for it with an API key or an SDK token is refused with 403, so a leaked key cannot bring a dormant key back to life.
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::UsersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the key belongs to
+key_id = 'key_id_example' # String | The `keyId` of the key, as the list shows it
+update_user_api_key_request = ApiSdkRb::UpdateUserApiKeyRequest.new # UpdateUserApiKeyRequest | 
+
+begin
+  # Rename an API key, or switch it off or on
+  result = api_instance.update_user_api_key_0(id, key_id, update_user_api_key_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->update_user_api_key_0: #{e}"
+end
+```
+
+#### Using the update_user_api_key_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserApiKeyResponse>, Integer, Hash)> update_user_api_key_0_with_http_info(id, key_id, update_user_api_key_request)
+
+```ruby
+begin
+  # Rename an API key, or switch it off or on
+  data, status_code, headers = api_instance.update_user_api_key_0_with_http_info(id, key_id, update_user_api_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserApiKeyResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling UsersApi->update_user_api_key_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account the key belongs to |  |
+| **key_id** | **String** | The &#x60;keyId&#x60; of the key, as the list shows it |  |
+| **update_user_api_key_request** | [**UpdateUserApiKeyRequest**](UpdateUserApiKeyRequest.md) |  |  |
+
+### Return type
+
+[**UserApiKeyResponse**](UserApiKeyResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+