qwil_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 852707f846254756754d2d52b0794781f2dd286d
+  data.tar.gz: 1ac9a016c92ae478f5b4feb146a96f258aaa7c00
+SHA512:
+  metadata.gz: 9447bab3076fa5700de4718c9e7d41b3396853a6c44a190c61c204577d049d44210ce4d9fda028759b1f3102ec7ba1532752962c9ba78a93d73b901c567b69da
+  data.tar.gz: be206ece0e6988a34aa89ceab62cb7e5444f84804da29132cad4a54f26cc2eb9a32b9d1d0f3dc482d4a96b7ea2fff4df06e1525ae22827148e8ae5cc9d2f1b0a

data/README.md

@@ -0,0 +1,91 @@
+# qwil_api
+
+QwilAPI - the Ruby gem for the 
+
+No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 
+- Package version: 0.1.0
+- Build date: 2016-12-22T19:24:41.076-08:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build qwil_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./qwil_api-0.1.0.gem
+```
+(for development, run `gem install --dev ./qwil_api-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'qwil_api', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'qwil_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::MembershipsApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #
+  result = api_instance.membership_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling MembershipsApi->membership_retrieve: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:8000/*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*QwilAPI::MembershipsApi* | [**membership_retrieve**](docs/MembershipsApi.md#membership_retrieve) | **GET** /memberships/{pk}/ | 
+
+
+## Documentation for Models
+
+ - [QwilAPI::MembershipSerializer](docs/MembershipSerializer.md)
+ - [QwilAPI::WriteMembershipSerializer](docs/WriteMembershipSerializer.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/docs/AccountSerializer.md

@@ -0,0 +1,18 @@
+# QwilAPI::AccountSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**account_number** | **String** |  | 
+**name** | **String** | The user's label for this Account. | 
+**routing_number** | **String** | The inter-bank routing nubmer for this Account. 8 or 9 digits in length. | 
+**is_tax_savings** | **BOOLEAN** | Flag specifying if the Account is used for tax savings. | 
+**is_paypal** | **BOOLEAN** | Flag specifying if the Account is a Paypal account. | 
+**is_mychoice** | **BOOLEAN** | Flag specifying if the Account is a MyChoice card. If it is, the mychoice_user_id and mychoice_card_id must be filled in. | 
+**mychoice_user_id** | **Integer** | For MyChoice Accounts. Populated from the MyChoice API. | 
+**mychoice_card_id** | **Integer** | For MyChoice Accounts. Populated from the MyChoice API. | 
+**deleted** | **BOOLEAN** | True if the Account has been deleted by an end-user. | 
+**user** | **String** |  | 
+
+

data/docs/AccountsApi.md

@@ -0,0 +1,243 @@
+# QwilAPI::AccountsApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_destroy**](AccountsApi.md#account_destroy) | **DELETE** /accounts/{pk}/ | The bank accounts for all Users
+[**account_partial_update**](AccountsApi.md#account_partial_update) | **PATCH** /accounts/{pk}/ | The bank accounts for all Users
+[**account_retrieve**](AccountsApi.md#account_retrieve) | **GET** /accounts/{pk}/ | The bank accounts for all Users
+[**account_update**](AccountsApi.md#account_update) | **PUT** /accounts/{pk}/ | The bank accounts for all Users
+
+
+# **account_destroy**
+> AccountSerializer account_destroy(pk)
+
+The bank accounts for all Users
+
+The bank accounts for all Users. Enables retrieve, update (PUT/PATCH), and destroy.<br/>Note that the Account API objects are immutable, but the DELETE API method is still offered to allow users to remove Accounts.<br/>Note that the Account DB models are immutable, but the PUT/PATCH/DELETE API methods are still offered to allow users to modify/remove Accounts.<br/>The PUT/PATCH HTTP methods will create a new Account with the same data as the old one, and then apply the update to that new account. The old Account will be marked as deleted.<br/>NOTE: if you update an Account, it will get a new primary key, and therefore a new URL. You will need to extract the new URL from the body of the HTTP response to the update request.<br/>e.g.<br/>=> PATCH https://api.qwil.co/accounts/1/ {...}<br/><= 200 OK {   \"url\": \"https://api.qwil.co/accounts/2/\",   ... }<br/>The DELETE HTTP method will cause Accounts to have the Account.deleted flag set to True, but deleted Accounts will still be displayed in the /accounts/ list.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::AccountsApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #The bank accounts for all Users
+  result = api_instance.account_destroy(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling AccountsApi->account_destroy: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**AccountSerializer**](AccountSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **account_partial_update**
+> AccountSerializer account_partial_update(pk, opts)
+
+The bank accounts for all Users
+
+The bank accounts for all Users. Enables retrieve, update (PUT/PATCH), and destroy.<br/>Note that the Account API objects are immutable, but the DELETE API method is still offered to allow users to remove Accounts.<br/>Note that the Account DB models are immutable, but the PUT/PATCH/DELETE API methods are still offered to allow users to modify/remove Accounts.<br/>The PUT/PATCH HTTP methods will create a new Account with the same data as the old one, and then apply the update to that new account. The old Account will be marked as deleted.<br/>NOTE: if you update an Account, it will get a new primary key, and therefore a new URL. You will need to extract the new URL from the body of the HTTP response to the update request.<br/>e.g.<br/>=> PATCH https://api.qwil.co/accounts/1/ {...}<br/><= 200 OK {   \"url\": \"https://api.qwil.co/accounts/2/\",   ... }<br/>The DELETE HTTP method will cause Accounts to have the Account.deleted flag set to True, but deleted Accounts will still be displayed in the /accounts/ list.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::AccountsApi.new
+
+pk = "pk_example" # String | 
+
+opts = { 
+  account_number: "account_number_example", # String | 
+  name: "name_example", # String | The user's label for this Account.
+  routing_number: "routing_number_example", # String | The inter-bank routing nubmer for this Account. 8 or 9 digits in length.
+  is_tax_savings: true, # BOOLEAN | Flag specifying if the Account is used for tax savings.
+  is_paypal: true, # BOOLEAN | Flag specifying if the Account is a Paypal account.
+  is_mychoice: true, # BOOLEAN | Flag specifying if the Account is a MyChoice card. If it is, the mychoice_user_id and mychoice_card_id must be filled in.
+  mychoice_user_id: 789, # Integer | For MyChoice Accounts. Populated from the MyChoice API.
+  mychoice_card_id: 789, # Integer | For MyChoice Accounts. Populated from the MyChoice API.
+  user: "user_example" # String | 
+}
+
+begin
+  #The bank accounts for all Users
+  result = api_instance.account_partial_update(pk, opts)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling AccountsApi->account_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+ **account_number** | **String**|  | [optional] 
+ **name** | **String**| The user&#39;s label for this Account. | [optional] 
+ **routing_number** | **String**| The inter-bank routing nubmer for this Account. 8 or 9 digits in length. | [optional] 
+ **is_tax_savings** | **BOOLEAN**| Flag specifying if the Account is used for tax savings. | [optional] 
+ **is_paypal** | **BOOLEAN**| Flag specifying if the Account is a Paypal account. | [optional] 
+ **is_mychoice** | **BOOLEAN**| Flag specifying if the Account is a MyChoice card. If it is, the mychoice_user_id and mychoice_card_id must be filled in. | [optional] 
+ **mychoice_user_id** | **Integer**| For MyChoice Accounts. Populated from the MyChoice API. | [optional] 
+ **mychoice_card_id** | **Integer**| For MyChoice Accounts. Populated from the MyChoice API. | [optional] 
+ **user** | **String**|  | [optional] 
+
+### Return type
+
+[**AccountSerializer**](AccountSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **account_retrieve**
+> AccountSerializer account_retrieve(pk)
+
+The bank accounts for all Users
+
+The bank accounts for all Users. Enables retrieve, update (PUT/PATCH), and destroy.<br/>Note that the Account API objects are immutable, but the DELETE API method is still offered to allow users to remove Accounts.<br/>Note that the Account DB models are immutable, but the PUT/PATCH/DELETE API methods are still offered to allow users to modify/remove Accounts.<br/>The PUT/PATCH HTTP methods will create a new Account with the same data as the old one, and then apply the update to that new account. The old Account will be marked as deleted.<br/>NOTE: if you update an Account, it will get a new primary key, and therefore a new URL. You will need to extract the new URL from the body of the HTTP response to the update request.<br/>e.g.<br/>=> PATCH https://api.qwil.co/accounts/1/ {...}<br/><= 200 OK {   \"url\": \"https://api.qwil.co/accounts/2/\",   ... }<br/>The DELETE HTTP method will cause Accounts to have the Account.deleted flag set to True, but deleted Accounts will still be displayed in the /accounts/ list.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::AccountsApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #The bank accounts for all Users
+  result = api_instance.account_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling AccountsApi->account_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**AccountSerializer**](AccountSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **account_update**
+> AccountSerializer account_update(pk, account_number, name, routing_number, opts)
+
+The bank accounts for all Users
+
+The bank accounts for all Users. Enables retrieve, update (PUT/PATCH), and destroy.<br/>Note that the Account API objects are immutable, but the DELETE API method is still offered to allow users to remove Accounts.<br/>Note that the Account DB models are immutable, but the PUT/PATCH/DELETE API methods are still offered to allow users to modify/remove Accounts.<br/>The PUT/PATCH HTTP methods will create a new Account with the same data as the old one, and then apply the update to that new account. The old Account will be marked as deleted.<br/>NOTE: if you update an Account, it will get a new primary key, and therefore a new URL. You will need to extract the new URL from the body of the HTTP response to the update request.<br/>e.g.<br/>=> PATCH https://api.qwil.co/accounts/1/ {...}<br/><= 200 OK {   \"url\": \"https://api.qwil.co/accounts/2/\",   ... }<br/>The DELETE HTTP method will cause Accounts to have the Account.deleted flag set to True, but deleted Accounts will still be displayed in the /accounts/ list.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::AccountsApi.new
+
+pk = "pk_example" # String | 
+
+account_number = "account_number_example" # String | 
+
+name = "name_example" # String | The user's label for this Account.
+
+routing_number = "routing_number_example" # String | The inter-bank routing nubmer for this Account. 8 or 9 digits in length.
+
+opts = { 
+  is_tax_savings: true, # BOOLEAN | Flag specifying if the Account is used for tax savings.
+  is_paypal: true, # BOOLEAN | Flag specifying if the Account is a Paypal account.
+  is_mychoice: true, # BOOLEAN | Flag specifying if the Account is a MyChoice card. If it is, the mychoice_user_id and mychoice_card_id must be filled in.
+  mychoice_user_id: 789, # Integer | For MyChoice Accounts. Populated from the MyChoice API.
+  mychoice_card_id: 789, # Integer | For MyChoice Accounts. Populated from the MyChoice API.
+  user: "user_example" # String | 
+}
+
+begin
+  #The bank accounts for all Users
+  result = api_instance.account_update(pk, account_number, name, routing_number, opts)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling AccountsApi->account_update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+ **account_number** | **String**|  | 
+ **name** | **String**| The user&#39;s label for this Account. | 
+ **routing_number** | **String**| The inter-bank routing nubmer for this Account. 8 or 9 digits in length. | 
+ **is_tax_savings** | **BOOLEAN**| Flag specifying if the Account is used for tax savings. | [optional] 
+ **is_paypal** | **BOOLEAN**| Flag specifying if the Account is a Paypal account. | [optional] 
+ **is_mychoice** | **BOOLEAN**| Flag specifying if the Account is a MyChoice card. If it is, the mychoice_user_id and mychoice_card_id must be filled in. | [optional] 
+ **mychoice_user_id** | **Integer**| For MyChoice Accounts. Populated from the MyChoice API. | [optional] 
+ **mychoice_card_id** | **Integer**| For MyChoice Accounts. Populated from the MyChoice API. | [optional] 
+ **user** | **String**|  | [optional] 
+
+### Return type
+
+[**AccountSerializer**](AccountSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/ApitokenauthApi.md

@@ -0,0 +1,57 @@
+# QwilAPI::ApitokenauthApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**obtain_json_web_token_post**](ApitokenauthApi.md#obtain_json_web_token_post) | **POST** /api-token-auth/ | API View that receives a POST with a user's username and password
+
+
+# **obtain_json_web_token_post**
+> JSONWebTokenSerializer obtain_json_web_token_post(opts)
+
+API View that receives a POST with a user's username and password
+
+API View that receives a POST with a user's username and password.<br/>Returns a JSON Web Token that can be used for authenticated requests.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::ApitokenauthApi.new
+
+opts = { 
+  json_web_token_serializer: QwilAPI::JSONWebTokenSerializer.new # JSONWebTokenSerializer | 
+}
+
+begin
+  #API View that receives a POST with a user's username and password
+  result = api_instance.obtain_json_web_token_post(opts)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling ApitokenauthApi->obtain_json_web_token_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **json_web_token_serializer** | [**JSONWebTokenSerializer**](JSONWebTokenSerializer.md)|  | [optional] 
+
+### Return type
+
+[**JSONWebTokenSerializer**](JSONWebTokenSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/CashoutCalculationSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::CashoutCalculationSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The Cashout amount to calculate fees for. (This amount is net, i.e. before fees). | 
+**fee** | **String** | The Cashout fee that would be charged for the requested amount. | 
+**maximum_available** | **String** | The maximum Cashout amount available for the User. (This amount is net, i.e. before fees). | 
+
+

data/docs/CashoutSerializer.md

@@ -0,0 +1,20 @@
+# QwilAPI::CashoutSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**amount** | **String** |  | 
+**fee** | **String** |  | 
+**cashout_time** | **DateTime** |  | 
+**notes** | **String** |  | 
+**type** | **String** |  | 
+**method** | **String** |  | 
+**status** | **String** |  | 
+**transmit_time** | **DateTime** |  | 
+**user** | **String** |  | 
+**rebate** | **String** | The Rebate against which this Cashout will be collected. | 
+**account** | **String** |  | 
+**incomes** | **Array<String>** | The Incomes that fund this Cashout. | 
+
+

data/docs/CashoutSliceSerializer.md

@@ -0,0 +1,11 @@
+# QwilAPI::CashoutSliceSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The amount of Income that is included in the Cashout. | 
+**fee** | **String** | The fee charged for this Cashout. | 
+**cashout** | **String** | The User-facing Cashout that this object funds. | 
+**income** | **String** | An Income that is providing funds for the linked Cashout. | 
+
+

data/docs/CashoutsApi.md

@@ -0,0 +1,56 @@
+# QwilAPI::CashoutsApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cashout_retrieve**](CashoutsApi.md#cashout_retrieve) | **GET** /cashouts/{pk}/ | The Cashouts endpoint for all Users
+
+
+# **cashout_retrieve**
+> CashoutSerializer cashout_retrieve(pk)
+
+The Cashouts endpoint for all Users
+
+The Cashouts endpoint for all Users. Only allows retrieval of individual objects e.g. GET /cashouts/1/.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::CashoutsApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #The Cashouts endpoint for all Users
+  result = api_instance.cashout_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling CashoutsApi->cashout_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**CashoutSerializer**](CashoutSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/CompanyInformationSerializer.md

@@ -0,0 +1,18 @@
+# QwilAPI::CompanyInformationSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_city** | **String** |  | 
+**address_state** | **String** |  | 
+**business_name** | **String** | Business name. Only use this field if this user is a business entity. | 
+**entity_type** | **String** |  | 
+**tax_id_type** | **String** |  | 
+**phone_number** | **String** |  | 
+**address_zip_code** | **String** |  | 
+**tax_id_number** | **String** |  | 
+**address** | **String** |  | 
+**email** | **String** |  | 
+**duns_number** | **String** |  | 
+
+

data/docs/ContactInfoSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::ContactInfoSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**email** | **String** |  | 
+
+

data/docs/ContactInformationSerializer.md

@@ -0,0 +1,16 @@
+# QwilAPI::ContactInformationSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | First name, if the user is an individual. Leave blank if this user is a company. | 
+**last_name** | **String** | Last name, if the user is an individual. Leave blank if this user is a company. | 
+**email** | **String** |  | 
+**entity_type** | **String** |  | 
+**address** | **String** |  | 
+**address_city** | **String** |  | 
+**address_state** | **String** |  | 
+**address_zip_code** | **String** |  | 
+**phone_number** | **String** |  | 
+
+

data/docs/ContractorSerializer.md

@@ -0,0 +1,20 @@
+# QwilAPI::ContractorSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**email** | **String** |  | 
+**income** | **String** | URL of the endpoint describing the User's Income. | 
+**name** | **String** | DEPRECATED: The full name of the contractor. Use first_name/last_name instead. | 
+**first_name** | **String** | First name, if the user is an individual. Leave blank if this user is a company. | 
+**last_name** | **String** | Last name, if the user is an individual. Leave blank if this user is a company. | 
+**business_name** | **String** | Business name. Only use this field if this user is a business entity. | 
+**contractor_type** | **String** |  | 
+**accounts** | **String** | URL of the endpoint describing the User's Accounts. | 
+**default_account** | **String** | Default account to use for payment of unpaid income. | 
+**cashouts** | **String** | URL of the endpoint describing the User's Cashouts. | 
+**calculate_cashout_available** | **String** | Calculate what fees would be charged for a specific Cashout amount. | 
+**has_password** | **String** | Flag specifying if the User has set their password. | 
+
+