checkbook 1.0.1

data/docs/User.md

@@ -0,0 +1,722 @@
+# Checkbook::User
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_api_key**](User.md#delete_api_key) | **DELETE** /v3/user/api_key/{key_id} | Delete API key for user |
+| [**delete_user**](User.md#delete_user) | **DELETE** /v3/user/{id} | Remove marketplace user |
+| [**get_api_keys**](User.md#get_api_keys) | **GET** /v3/user/api_key | Get API keys for user |
+| [**get_user**](User.md#get_user) | **GET** /v3/user | Get user details |
+| [**get_users**](User.md#get_users) | **GET** /v3/user/list | Get marketplace users |
+| [**new_api_key**](User.md#new_api_key) | **POST** /v3/user/api_key | Generate new API Key for user |
+| [**post_user**](User.md#post_user) | **POST** /v3/user | Create user |
+| [**post_user_signature**](User.md#post_user_signature) | **POST** /v3/user/signature | Add signature for user |
+| [**put_user**](User.md#put_user) | **PUT** /v3/user | Update user |
+| [**put_user_webhook**](User.md#put_user_webhook) | **PUT** /v3/user/webhook | Update a sandbox user status |
+
+
+## delete_api_key
+
+> delete_api_key(key_id)
+
+Delete API key for user
+
+Delete API key for user
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+key_id = 'key_id_example' # String | 
+
+begin
+  # Delete API key for user
+  api_instance.delete_api_key(key_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->delete_api_key: #{e}"
+end
+```
+
+#### Using the delete_api_key_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_api_key_with_http_info(key_id)
+
+```ruby
+begin
+  # Delete API key for user
+  data, status_code, headers = api_instance.delete_api_key_with_http_info(key_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->delete_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_user
+
+> delete_user(id)
+
+Remove marketplace user
+
+Delete a marketplace user.  > [!NOTE] > **Tip**   > The id that gets passed in needs to be the Checkbook system generated `id`, not the `user_id`.  > Users with active transactions may not be deleted.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+id = 'id_example' # String | 
+
+begin
+  # Remove marketplace user
+  api_instance.delete_user(id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->delete_user: #{e}"
+end
+```
+
+#### Using the delete_user_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_user_with_http_info(id)
+
+```ruby
+begin
+  # Remove marketplace user
+  data, status_code, headers = api_instance.delete_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->delete_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_api_keys
+
+> <APIKeyListResponse> get_api_keys
+
+Get API keys for user
+
+Return the API keys for the user
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+
+begin
+  # Get API keys for user
+  result = api_instance.get_api_keys
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_api_keys: #{e}"
+end
+```
+
+#### Using the get_api_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<APIKeyListResponse>, Integer, Hash)> get_api_keys_with_http_info
+
+```ruby
+begin
+  # Get API keys for user
+  data, status_code, headers = api_instance.get_api_keys_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <APIKeyListResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_api_keys_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**APIKeyListResponse**](APIKeyListResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user
+
+> <GetUserResponse> get_user
+
+Get user details
+
+Get user information
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+
+begin
+  # Get user details
+  result = api_instance.get_user
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserResponse>, Integer, Hash)> get_user_with_http_info
+
+```ruby
+begin
+  # Get user details
+  data, status_code, headers = api_instance.get_user_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetUserResponse**](GetUserResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_users
+
+> <UserQueryResponse> get_users(opts)
+
+Get marketplace users
+
+Return the marketplace users
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+opts = {
+  page: 56, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'q_example', # String | Query
+  sort: '+DATE' # String | Sort
+}
+
+begin
+  # Get marketplace users
+  result = api_instance.get_users(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_users: #{e}"
+end
+```
+
+#### Using the get_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserQueryResponse>, Integer, Hash)> get_users_with_http_info(opts)
+
+```ruby
+begin
+  # Get marketplace users
+  data, status_code, headers = api_instance.get_users_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserQueryResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->get_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **q** | **String** | Query | [optional] |
+| **sort** | **String** | Sort | [optional] |
+
+### Return type
+
+[**UserQueryResponse**](UserQueryResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## new_api_key
+
+> <NewApiKeyResponse> new_api_key(new_api_key_request)
+
+Generate new API Key for user
+
+Generate new API keys for the user
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+new_api_key_request = Checkbook::NewApiKeyRequest.new # NewApiKeyRequest | 
+
+begin
+  # Generate new API Key for user
+  result = api_instance.new_api_key(new_api_key_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->new_api_key: #{e}"
+end
+```
+
+#### Using the new_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NewApiKeyResponse>, Integer, Hash)> new_api_key_with_http_info(new_api_key_request)
+
+```ruby
+begin
+  # Generate new API Key for user
+  data, status_code, headers = api_instance.new_api_key_with_http_info(new_api_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NewApiKeyResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->new_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **new_api_key_request** | [**NewApiKeyRequest**](NewApiKeyRequest.md) |  |  |
+
+### Return type
+
+[**NewApiKeyResponse**](NewApiKeyResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_user
+
+> <CreateUserResponse> post_user(create_user_request)
+
+Create user
+
+Create a new marketplace user.   > [!NOTE] > **Common Errors** > > - **`403: FORBIDDEN`**: Please ensure you are using the Marketplace Owner's keys. If the `403` error persists, it may indicate that marketplace is not enabled for your account or you do not have an active billing bank account onboarded. Contact support@checkbook.io for more details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+create_user_request = Checkbook::CreateUserRequest.new({name: 'name_example', user_id: 'user_id_example'}) # CreateUserRequest | 
+
+begin
+  # Create user
+  result = api_instance.post_user(create_user_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->post_user: #{e}"
+end
+```
+
+#### Using the post_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateUserResponse>, Integer, Hash)> post_user_with_http_info(create_user_request)
+
+```ruby
+begin
+  # Create user
+  data, status_code, headers = api_instance.post_user_with_http_info(create_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateUserResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->post_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) |  |  |
+
+### Return type
+
+[**CreateUserResponse**](CreateUserResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_user_signature
+
+> post_user_signature(signature_request)
+
+Add signature for user
+
+Add signature
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+signature_request = Checkbook::SignatureRequest.new({signature: 'signature_example'}) # SignatureRequest | 
+
+begin
+  # Add signature for user
+  api_instance.post_user_signature(signature_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->post_user_signature: #{e}"
+end
+```
+
+#### Using the post_user_signature_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_user_signature_with_http_info(signature_request)
+
+```ruby
+begin
+  # Add signature for user
+  data, status_code, headers = api_instance.post_user_signature_with_http_info(signature_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->post_user_signature_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **signature_request** | [**SignatureRequest**](SignatureRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_user
+
+> put_user(update_user_request)
+
+Update user
+
+Update existing user information.   > [!NOTE] > **Note**   > This endpoint is used for updating a user's KYB/KYC information. Checkbook validates this information asynchronously.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+update_user_request = Checkbook::UpdateUserRequest.new # UpdateUserRequest | 
+
+begin
+  # Update user
+  api_instance.put_user(update_user_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->put_user: #{e}"
+end
+```
+
+#### Using the put_user_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> put_user_with_http_info(update_user_request)
+
+```ruby
+begin
+  # Update user
+  data, status_code, headers = api_instance.put_user_with_http_info(update_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->put_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_user_webhook
+
+> put_user_webhook(trigger_user_webhook_request)
+
+Update a sandbox user status
+
+Update a user's status in the sandbox environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::User.new
+trigger_user_webhook_request = Checkbook::TriggerUserWebhookRequest.new({status: 'UNVERIFIED'}) # TriggerUserWebhookRequest | 
+
+begin
+  # Update a sandbox user status
+  api_instance.put_user_webhook(trigger_user_webhook_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->put_user_webhook: #{e}"
+end
+```
+
+#### Using the put_user_webhook_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> put_user_webhook_with_http_info(trigger_user_webhook_request)
+
+```ruby
+begin
+  # Update a sandbox user status
+  data, status_code, headers = api_instance.put_user_webhook_with_http_info(trigger_user_webhook_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling User->put_user_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trigger_user_webhook_request** | [**TriggerUserWebhookRequest**](TriggerUserWebhookRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+