aimastering 1.0.0

data/docs/Payment.md

@@ -0,0 +1,14 @@
+# Aimastering::Payment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**service** | **String** |  | [optional] 
+**product_given** | **BOOLEAN** |  | [optional] 
+**product** | **Object** |  | [optional] 
+**transaction_id** | **String** |  | [optional] 
+**transaction_detail** | **Object** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+
+

data/docs/PaymentApi.md

@@ -0,0 +1,224 @@
+# Aimastering::PaymentApi
+
+All URIs are relative to *https://aimastering.com:443/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_payment**](PaymentApi.md#create_payment) | **POST** /payments | Create a new payment.
+[**execute_payment**](PaymentApi.md#execute_payment) | **PUT** /payments/{id}/execute | Execute a payment by id.
+[**get_payment**](PaymentApi.md#get_payment) | **GET** /payments/{id} | Get a payment by id.
+[**list_payments**](PaymentApi.md#list_payments) | **GET** /payments | Get all accessable payments.
+
+
+# **create_payment**
+> Payment create_payment(product_token, service, opts)
+
+Create a new payment.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PaymentApi.new
+
+product_token = "product_token_example" # String | This parameter represents the product token.
+
+service = "service_example" # String | This parameter represents the payment message.
+
+opts = { 
+  token: "token_example" # String | This parameter represents the card token. This parameter is effective only when the service is \"stripe\".
+}
+
+begin
+  #Create a new payment.
+  result = api_instance.create_payment(product_token, service, opts)
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PaymentApi->create_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_token** | **String**| This parameter represents the product token. | 
+ **service** | **String**| This parameter represents the payment message. | 
+ **token** | **String**| This parameter represents the card token. This parameter is effective only when the service is \"stripe\". | [optional] 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **execute_payment**
+> Payment execute_payment(id, payer_id)
+
+Execute a payment by id.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PaymentApi.new
+
+id = 56 # Integer | Payment id
+
+payer_id = "payer_id_example" # String | This parameter represents the card token. This parameter is effective only when the service is \"paypal\".
+
+
+begin
+  #Execute a payment by id.
+  result = api_instance.execute_payment(id, payer_id)
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PaymentApi->execute_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Payment id | 
+ **payer_id** | **String**| This parameter represents the card token. This parameter is effective only when the service is \"paypal\". | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **get_payment**
+> Payment get_payment(id)
+
+Get a payment by id.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PaymentApi.new
+
+id = 56 # Integer | Payment id
+
+
+begin
+  #Get a payment by id.
+  result = api_instance.get_payment(id)
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PaymentApi->get_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Payment id | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_payments**
+> Array<Payment> list_payments
+
+Get all accessable payments.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PaymentApi.new
+
+begin
+  #Get all accessable payments.
+  result = api_instance.list_payments
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PaymentApi->list_payments: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Payment>**](Payment.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PaymentCustomer.md

@@ -0,0 +1,11 @@
+# Aimastering::PaymentCustomer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**payment_customer_detail** | **Object** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/PaymentCustomerApi.md

@@ -0,0 +1,55 @@
+# Aimastering::PaymentCustomerApi
+
+All URIs are relative to *https://aimastering.com:443/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_default_payment_customer**](PaymentCustomerApi.md#get_default_payment_customer) | **GET** /payment_customers/default | Get a default payment customer.
+
+
+# **get_default_payment_customer**
+> Array<PaymentCustomer> get_default_payment_customer
+
+Get a default payment customer.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PaymentCustomerApi.new
+
+begin
+  #Get a default payment customer.
+  result = api_instance.get_default_payment_customer
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PaymentCustomerApi->get_default_payment_customer: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<PaymentCustomer>**](PaymentCustomer.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Plan.md

@@ -0,0 +1,12 @@
+# Aimastering::Plan
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** |  | [optional] 
+**currency** | **String** |  | [optional] 
+**interval** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**stripe_plan_id** | **String** |  | [optional] 
+
+

data/docs/PlanApi.md

@@ -0,0 +1,55 @@
+# Aimastering::PlanApi
+
+All URIs are relative to *https://aimastering.com:443/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_plans**](PlanApi.md#list_plans) | **GET** /plans | Get all accessable plans.
+
+
+# **list_plans**
+> Array<Plan> list_plans
+
+Get all accessable plans.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::PlanApi.new
+
+begin
+  #Get all accessable plans.
+  result = api_instance.list_plans
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling PlanApi->list_plans: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Plan>**](Plan.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/StatisticsApi.md

@@ -0,0 +1,102 @@
+# Aimastering::StatisticsApi
+
+All URIs are relative to *https://aimastering.com:443/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_anonymized_masterings**](StatisticsApi.md#list_anonymized_masterings) | **GET** /statistics/anonymized_masterings | Get anonymized masterings.
+[**list_kpis**](StatisticsApi.md#list_kpis) | **GET** /statistics/kpis | Get KPIs.
+
+
+# **list_anonymized_masterings**
+> Array<AnonymizedMastering> list_anonymized_masterings
+
+Get anonymized masterings.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::StatisticsApi.new
+
+begin
+  #Get anonymized masterings.
+  result = api_instance.list_anonymized_masterings
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling StatisticsApi->list_anonymized_masterings: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<AnonymizedMastering>**](AnonymizedMastering.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_kpis**
+> Kpi list_kpis
+
+Get KPIs.
+
+### Example
+```ruby
+# load the gem
+require 'aimastering'
+# setup authorization
+Aimastering.configure do |config|
+  # Configure API key authorization: bearer
+  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 = Aimastering::StatisticsApi.new
+
+begin
+  #Get KPIs.
+  result = api_instance.list_kpis
+  p result
+rescue Aimastering::ApiError => e
+  puts "Exception when calling StatisticsApi->list_kpis: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Kpi**](Kpi.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+