checkbook 1.0.1

data/docs/Card.md

@@ -0,0 +1,290 @@
+# Checkbook::Card
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_card**](Card.md#delete_card) | **DELETE** /v3/account/card/{card_id} | Remove card |
+| [**get_cards**](Card.md#get_cards) | **GET** /v3/account/card | Get cards |
+| [**post_card**](Card.md#post_card) | **POST** /v3/account/card | Add card |
+| [**put_card**](Card.md#put_card) | **PUT** /v3/account/card/{card_id} | Update card |
+
+
+## delete_card
+
+> delete_card(card_id)
+
+Remove card
+
+Remove the specified card
+
+### 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::Card.new
+card_id = 'card_id_example' # String | 
+
+begin
+  # Remove card
+  api_instance.delete_card(card_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->delete_card: #{e}"
+end
+```
+
+#### Using the delete_card_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_card_with_http_info(card_id)
+
+```ruby
+begin
+  # Remove card
+  data, status_code, headers = api_instance.delete_card_with_http_info(card_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->delete_card_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_cards
+
+> <GetCardsResponse> get_cards
+
+Get cards
+
+Return the cards
+
+### 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::Card.new
+
+begin
+  # Get cards
+  result = api_instance.get_cards
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->get_cards: #{e}"
+end
+```
+
+#### Using the get_cards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCardsResponse>, Integer, Hash)> get_cards_with_http_info
+
+```ruby
+begin
+  # Get cards
+  data, status_code, headers = api_instance.get_cards_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCardsResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->get_cards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetCardsResponse**](GetCardsResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_card
+
+> <CreateCardResponse> post_card(create_card_request)
+
+Add card
+
+Add a new card
+
+### 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::Card.new
+create_card_request = Checkbook::CreateCardRequest.new({card_number: 'card_number_example', expiration_date: 'expiration_date_example'}) # CreateCardRequest | 
+
+begin
+  # Add card
+  result = api_instance.post_card(create_card_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->post_card: #{e}"
+end
+```
+
+#### Using the post_card_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCardResponse>, Integer, Hash)> post_card_with_http_info(create_card_request)
+
+```ruby
+begin
+  # Add card
+  data, status_code, headers = api_instance.post_card_with_http_info(create_card_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCardResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->post_card_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_card_request** | [**CreateCardRequest**](CreateCardRequest.md) |  |  |
+
+### Return type
+
+[**CreateCardResponse**](CreateCardResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_card
+
+> put_card(card_id, update_card_request)
+
+Update card
+
+Update the specified card
+
+### 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::Card.new
+card_id = 'card_id_example' # String | 
+update_card_request = Checkbook::UpdateCardRequest.new # UpdateCardRequest | 
+
+begin
+  # Update card
+  api_instance.put_card(card_id, update_card_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->put_card: #{e}"
+end
+```
+
+#### Using the put_card_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_card_with_http_info(card_id, update_card_request)
+
+```ruby
+begin
+  # Update card
+  data, status_code, headers = api_instance.put_card_with_http_info(card_id, update_card_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Card->put_card_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** |  |  |
+| **update_card_request** | [**UpdateCardRequest**](UpdateCardRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Checkbook.md

@@ -0,0 +1,370 @@
+# Checkbook::Checkbook
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_checkbook**](Checkbook.md#delete_checkbook) | **DELETE** /v3/checkbook/{checkbook_id} | Cancel a checkbook |
+| [**get_checkbook**](Checkbook.md#get_checkbook) | **GET** /v3/checkbook/{checkbook_id} | Get checkbook |
+| [**get_checkbook_tracking**](Checkbook.md#get_checkbook_tracking) | **GET** /v3/checkbook/{checkbook_id}/tracking | Get tracking details on checkbooks |
+| [**get_checkbooks**](Checkbook.md#get_checkbooks) | **GET** /v3/checkbook | Get checkbooks |
+| [**order_checkbook**](Checkbook.md#order_checkbook) | **POST** /v3/checkbook | Order a checkbook |
+
+
+## delete_checkbook
+
+> delete_checkbook(checkbook_id)
+
+Cancel a checkbook
+
+Cancel the specified checkbook order
+
+### 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::Checkbook.new
+checkbook_id = 'checkbook_id_example' # String | 
+
+begin
+  # Cancel a checkbook
+  api_instance.delete_checkbook(checkbook_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->delete_checkbook: #{e}"
+end
+```
+
+#### Using the delete_checkbook_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_checkbook_with_http_info(checkbook_id)
+
+```ruby
+begin
+  # Cancel a checkbook
+  data, status_code, headers = api_instance.delete_checkbook_with_http_info(checkbook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->delete_checkbook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkbook_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_checkbook
+
+> <GetCheckbookResponse> get_checkbook(checkbook_id)
+
+Get checkbook
+
+Get the specified checkbook
+
+### 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::Checkbook.new
+checkbook_id = 'checkbook_id_example' # String | 
+
+begin
+  # Get checkbook
+  result = api_instance.get_checkbook(checkbook_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbook: #{e}"
+end
+```
+
+#### Using the get_checkbook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckbookResponse>, Integer, Hash)> get_checkbook_with_http_info(checkbook_id)
+
+```ruby
+begin
+  # Get checkbook
+  data, status_code, headers = api_instance.get_checkbook_with_http_info(checkbook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckbookResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkbook_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckbookResponse**](GetCheckbookResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_checkbook_tracking
+
+> <GetCheckbookTrackingResponseExpress> get_checkbook_tracking(checkbook_id)
+
+Get tracking details on checkbooks
+
+Get tracking details on checkbook
+
+### 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::Checkbook.new
+checkbook_id = 'checkbook_id_example' # String | 
+
+begin
+  # Get tracking details on checkbooks
+  result = api_instance.get_checkbook_tracking(checkbook_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbook_tracking: #{e}"
+end
+```
+
+#### Using the get_checkbook_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckbookTrackingResponseExpress>, Integer, Hash)> get_checkbook_tracking_with_http_info(checkbook_id)
+
+```ruby
+begin
+  # Get tracking details on checkbooks
+  data, status_code, headers = api_instance.get_checkbook_tracking_with_http_info(checkbook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckbookTrackingResponseExpress>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbook_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkbook_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckbookTrackingResponseExpress**](GetCheckbookTrackingResponseExpress.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_checkbooks
+
+> <GetCheckbooksResponse> get_checkbooks(opts)
+
+Get checkbooks
+
+Return the checkbooks issued for a 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::Checkbook.new
+opts = {
+  page: 1, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'q_example' # String | Query
+}
+
+begin
+  # Get checkbooks
+  result = api_instance.get_checkbooks(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbooks: #{e}"
+end
+```
+
+#### Using the get_checkbooks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckbooksResponse>, Integer, Hash)> get_checkbooks_with_http_info(opts)
+
+```ruby
+begin
+  # Get checkbooks
+  data, status_code, headers = api_instance.get_checkbooks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckbooksResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->get_checkbooks_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] |
+
+### Return type
+
+[**GetCheckbooksResponse**](GetCheckbooksResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## order_checkbook
+
+> <GetCheckbookResponse> order_checkbook(base_checkbook_request)
+
+Order a checkbook
+
+Order a new Checkbook   > [!NOTE] > The address printed on the checkbook is the user's merchant address provided in `merchant` object when calling [`PUT /v3/user`](#tag/user/put/v3/user). If the user does not have a merchant address, the shipping address provided in the `recipient` object will be printed on the checkbook.
+
+### 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::Checkbook.new
+base_checkbook_request = Checkbook::BaseCheckbookRequest.new({account: 1e31faa3c38f451aa6095fbd84e6bcbb, mail_type: 'USPS_FIRST_CLASS', number: '5001', recipient: Checkbook::CheckbookAddress.new({city: 'Scranton', line_1: '1234 N. 1st Street', state: 'PA', zip: '55555'})}) # BaseCheckbookRequest | 
+
+begin
+  # Order a checkbook
+  result = api_instance.order_checkbook(base_checkbook_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->order_checkbook: #{e}"
+end
+```
+
+#### Using the order_checkbook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckbookResponse>, Integer, Hash)> order_checkbook_with_http_info(base_checkbook_request)
+
+```ruby
+begin
+  # Order a checkbook
+  data, status_code, headers = api_instance.order_checkbook_with_http_info(base_checkbook_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckbookResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Checkbook->order_checkbook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base_checkbook_request** | [**BaseCheckbookRequest**](BaseCheckbookRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckbookResponse**](GetCheckbookResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+