billabear 1.0.0

data/docs/ProductsApi.md

@@ -0,0 +1,228 @@
+# SwaggerClient::ProductsApi
+
+All URIs are relative to *https://{customerId}.billabear.cloud/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_product**](ProductsApi.md#create_product) | **POST** /product | Create
+[**list_product**](ProductsApi.md#list_product) | **GET** /product | List
+[**show_product_by_id**](ProductsApi.md#show_product_by_id) | **GET** /product/{productId} | Detail
+[**update_product**](ProductsApi.md#update_product) | **PUT** /product/{productId} | Update
+
+# **create_product**
+> String create_product(body)
+
+Create
+
+Create a product
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ProductsApi.new
+body = SwaggerClient::Product.new # Product | 
+
+
+begin
+  #Create
+  result = api_instance.create_product(body)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProductsApi->create_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Product**](Product.md)|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_product**
+> InlineResponse2008 list_product(opts)
+
+List
+
+List all products
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ProductsApi.new
+opts = { 
+  limit: 56, # Integer | How many items to return at one time (max 100)
+  last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
+  name: 'name_example' # String | The name to search for
+}
+
+begin
+  #List
+  result = api_instance.list_product(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProductsApi->list_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional] 
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional] 
+ **name** | **String**| The name to search for | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **show_product_by_id**
+> Product show_product_by_id(product_id)
+
+Detail
+
+Info for a specific product
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ProductsApi.new
+product_id = 'product_id_example' # String | The id of the product to retrieve
+
+
+begin
+  #Detail
+  result = api_instance.show_product_by_id(product_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProductsApi->show_product_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The id of the product to retrieve | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_product**
+> Product update_product(product_id)
+
+Update
+
+Update a product
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ProductsApi.new
+product_id = 'product_id_example' # String | The id of the product to retrieve
+
+
+begin
+  #Update
+  result = api_instance.update_product(product_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProductsApi->update_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The id of the product to retrieve | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ReceiptApi.md

@@ -0,0 +1,61 @@
+# SwaggerClient::ReceiptApi
+
+All URIs are relative to *https://{customerId}.billabear.cloud/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**download_receipt**](ReceiptApi.md#download_receipt) | **GET** /receipt/{receiptId}/download | Download Receipt
+
+# **download_receipt**
+> String download_receipt(receipt)
+
+Download Receipt
+
+Returns the pdf blob for the Receipt
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ReceiptApi.new
+receipt = 'receipt_example' # String | The id of the receipt
+
+
+begin
+  #Download Receipt
+  result = api_instance.download_receipt(receipt)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReceiptApi->download_receipt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **receipt** | **String**| The id of the receipt | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf
+
+
+

data/docs/Refund.md

@@ -0,0 +1,16 @@
+# SwaggerClient::Refund
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**amount** | **Integer** |  | [optional] 
+**currency** | **String** | Three-letter ISO currency code. Must be upper-case | [optional] 
+**external_reference** | **String** |  | [optional] 
+**comment** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**payment** | [**Paths1paymentgetresponses200contentapplication1jsonschemapropertiesdataitems**](Paths1paymentgetresponses200contentapplication1jsonschemapropertiesdataitems.md) |  | [optional] 
+**customer** | [**Customer**](Customer.md) |  | [optional] 
+**billing_admin** | [**BillingAdmin**](BillingAdmin.md) |  | [optional] 
+

data/docs/RefundsApi.md

@@ -0,0 +1,181 @@
+# SwaggerClient::RefundsApi
+
+All URIs are relative to *https://{customerId}.billabear.cloud/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_refunds_for_customer**](RefundsApi.md#get_refunds_for_customer) | **GET** /customer/{customerId}/refund | List Customer Refunds
+[**list_refund**](RefundsApi.md#list_refund) | **GET** /refund | List
+[**show_refund_by_id**](RefundsApi.md#show_refund_by_id) | **GET** /refund/{refundId} | Detail
+
+# **get_refunds_for_customer**
+> InlineResponse2002 get_refunds_for_customer(customer_id, opts)
+
+List Customer Refunds
+
+List Customer Refund
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::RefundsApi.new
+customer_id = 'customer_id_example' # String | The id of the customer to retrieve
+opts = { 
+  limit: 56, # Integer | How many items to return at one time (max 100)
+  last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
+  name: 'name_example' # String | The name to search for
+}
+
+begin
+  #List Customer Refunds
+  result = api_instance.get_refunds_for_customer(customer_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RefundsApi->get_refunds_for_customer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_id** | **String**| The id of the customer to retrieve | 
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional] 
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional] 
+ **name** | **String**| The name to search for | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_refund**
+> InlineResponse2002 list_refund(opts)
+
+List
+
+List all refund
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::RefundsApi.new
+opts = { 
+  limit: 56, # Integer | How many items to return at one time (max 100)
+  last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
+  name: 'name_example' # String | The name to search for
+}
+
+begin
+  #List
+  result = api_instance.list_refund(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RefundsApi->list_refund: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional] 
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional] 
+ **name** | **String**| The name to search for | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **show_refund_by_id**
+> Refund show_refund_by_id(refund_id)
+
+Detail
+
+Info for a specific Refund
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::RefundsApi.new
+refund_id = 'refund_id_example' # String | The id of the refund
+
+
+begin
+  #Detail
+  result = api_instance.show_refund_by_id(refund_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RefundsApi->show_refund_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund_id** | **String**| The id of the refund | 
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SeatsAddBody.md

@@ -0,0 +1,7 @@
+# SwaggerClient::SeatsAddBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**seats** | **Integer** |  | 
+

data/docs/SeatsRemoveBody.md

@@ -0,0 +1,7 @@
+# SwaggerClient::SeatsRemoveBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**seats** | **Integer** |  | 
+

data/docs/Subscription.md

@@ -0,0 +1,18 @@
+# SwaggerClient::Subscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**seat_number** | **Integer** |  | [optional] 
+**schedule** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**ended_at** | **String** |  | [optional] 
+**valid_until** | **String** |  | [optional] 
+**main_external_reference** | **String** |  | [optional] 
+**child_external_reference** | **String** |  | [optional] 
+**price** | [**Price**](Price.md) |  | [optional] 
+**plan** | [**SubscriptionPlan**](SubscriptionPlan.md) |  | [optional] 
+

data/docs/SubscriptionIdCancelBody.md

@@ -0,0 +1,10 @@
+# SwaggerClient::SubscriptionIdCancelBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_when** | **String** |  | [default to 'end-of-run']
+**refund_type** | **String** |  | [default to 'none']
+**date** | **Date** |  | [optional] 
+**comment** | **String** |  | [optional] 
+

data/docs/SubscriptionIdExtendBody.md

@@ -0,0 +1,7 @@
+# SwaggerClient::SubscriptionIdExtendBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | [**Uuid**](Uuid.md) |  | 
+

data/docs/SubscriptionIdPlanBody.md

@@ -0,0 +1,9 @@
+# SwaggerClient::SubscriptionIdPlanBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_when** | **String** |  | 
+**plan** | **String** | The ID for the subscription plan to be used | [optional] 
+**price** | **String** | The ID for the price to be used | 
+

data/docs/SubscriptionIdPriceBody.md

@@ -0,0 +1,8 @@
+# SwaggerClient::SubscriptionIdPriceBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | [**Uuid**](Uuid.md) |  | 
+**_when** | **String** |  | 
+

data/docs/SubscriptionPlan.md

@@ -0,0 +1,20 @@
+# SwaggerClient::SubscriptionPlan
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**code_name** | **String** |  | [optional] 
+**user_count** | **Integer** |  | [optional] 
+**per_seat** | **BOOLEAN** |  | [optional] 
+**has_trial** | **BOOLEAN** |  | [optional] 
+**is_trial_standalone** | **BOOLEAN** |  | [optional] 
+**free** | **BOOLEAN** |  | [optional] 
+**public** | **BOOLEAN** |  | [optional] 
+**limits** | [**Array<Limit>**](Limit.md) |  | [optional] 
+**features** | [**Array<Feature>**](Feature.md) |  | [optional] 
+**product** | [**Product**](Product.md) |  | [optional] 
+**prices** | [**Array<Price>**](Price.md) |  | [optional] 
+**trial_length_days** | **Integer** |  | [optional] 
+

data/docs/SubscriptionStartBody.md

@@ -0,0 +1,14 @@
+# SwaggerClient::SubscriptionStartBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_plan** | **String** | The ID for the subscription plan to be used (Can also be the code name) | 
+**payment_details** | **String** | The Id for the customer's payment details to be used | [optional] 
+**card_token** | **String** | A stripe card token that's been created using Stripe's js sdk. It'll create the payment details for the customer. | [optional] 
+**price** | **String** | The ID for the price to be used | [optional] 
+**schedule** | **String** | The schedule of the plan that is to be started. Only used if price isn't given. Requires currency as well. | [optional] 
+**currency** | **String** | The currency of the plan that is to be started. Only used if price isn't given. Requires schedule as well. | [optional] 
+**seat_numbrers** | **Integer** |  | [optional] 
+**deny_trial** | [**Bool**](Bool.md) |  | [optional] 
+

data/docs/SubscriptionTrialBody.md

@@ -0,0 +1,10 @@
+# SwaggerClient::SubscriptionTrialBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_plan** | **String** | The ID for the subscription plan to be used (Can also be the code name) | 
+**card_token** | **String** | A stripe card token that's been created using Stripe's js sdk. It'll create the payment details for the customer. | [optional] 
+**seat_numbrers** | **Integer** |  | [optional] 
+**trial_length_days** | **Integer** |  | [optional] 
+