qwil_api 0.1.0

data/docs/RebateSerializer.md

@@ -0,0 +1,15 @@
+# QwilAPI::RebateSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**income** | **Array<String>** |  | 
+**cashout_slices** | [**Array<CashoutSliceSerializer>**](CashoutSliceSerializer.md) |  | 
+**amount** | **String** |  | 
+**paid** | **String** |  | 
+**user** | **String** |  | 
+**invoice** | **String** | The Invoice that will pay for this Rebate. | 
+**payments** | **Array<String>** | Flag recording whether this Rebate has been paid to the Contractor. | 
+
+

data/docs/RebatesApi.md

@@ -0,0 +1,98 @@
+# QwilAPI::RebatesApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**rebate_list**](RebatesApi.md#rebate_list) | **GET** /rebates/ | 
+[**rebate_retrieve**](RebatesApi.md#rebate_retrieve) | **GET** /rebates/{pk}/ | 
+
+
+# **rebate_list**
+> Array<RebateSerializer> rebate_list
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::RebatesApi.new
+
+begin
+  #
+  result = api_instance.rebate_list
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling RebatesApi->rebate_list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<RebateSerializer>**](RebateSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **rebate_retrieve**
+> RebateSerializer rebate_retrieve(pk)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::RebatesApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #
+  result = api_instance.rebate_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling RebatesApi->rebate_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**RebateSerializer**](RebateSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/ReceivablesSerializer.md

@@ -0,0 +1,9 @@
+# QwilAPI::ReceivablesSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+**amount** | **String** |  | 
+
+

data/docs/TaxSavingsSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::TaxSavingsSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_savings_percent** | **String** | The percent of income to be withheld for tax savings purposes. | 
+**pending** | **String** |  | 
+**balance** | **String** |  | 
+
+

data/docs/UserAccountSerializer.md

@@ -0,0 +1,17 @@
+# QwilAPI::UserAccountSerializer
+
+## 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_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/UserCashoutSerializer.md

@@ -0,0 +1,20 @@
+# QwilAPI::UserCashoutSerializer
+
+## 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/UserIncomeRequestSerializer.md

@@ -0,0 +1,15 @@
+# QwilAPI::UserIncomeRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**actions** | **String** |  | 
+**status** | **String** | The status of the income request. | 
+**amount** | **String** | The dollar value of income requested by the User | 
+**note** | **String** | Text visible to the Platform and User describing the Income Request | 
+**request_time** | **DateTime** | The time the IncomeRequest was submitted by the User | 
+**platform** | **String** | The platform that the User is requesting Income from. | 
+**income** | **String** | The resulting Income | 
+
+

data/docs/UserPlatformMembershipRequestSerializer.md

@@ -0,0 +1,13 @@
+# QwilAPI::UserPlatformMembershipRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**actions** | **String** |  | 
+**decision_maker** | [**ContactInfoSerializer**](ContactInfoSerializer.md) |  | 
+**platform_summary** | [**PlatformSummarySerializer**](PlatformSummarySerializer.md) |  | 
+**status** | **String** | The status of the membership request. | 
+**platform** | **String** | The platform that the User requests to join. | 
+
+

data/docs/UserSerializer.md

@@ -0,0 +1,40 @@
+# QwilAPI::UserSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**email** | **String** |  | 
+**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** |  | 
+**default_account** | **String** | Default account to use for payment of unpaid income. | 
+**kyc_status** | **String** | Status of the User's KYC check. | 
+**tax_savings_account** | **String** | Account to use for tax savings. | 
+**tax_savings_percent** | **String** | The percent of income to be withheld for tax savings purposes. | 
+**use_plaid** | **BOOLEAN** | Feature flag specifying if Plaid integration should be used. | 
+**use_income_requests** | **BOOLEAN** | Feature flag specifying if IncomeRequests should be enabled for this user. | 
+**use_tax_savings** | **BOOLEAN** | Feature flag specifying if tax savings should be enabled. | 
+**is_auto_cashout_enabled** | **BOOLEAN** | Whether or not all income should be immediately cashed out for this user. | 
+**income** | **String** | URL of the endpoint describing the User's Income. | 
+**cashouts** | **String** | URL of the endpoint describing the User's Cashouts. | 
+**receivables** | **String** | URL of the endpoint describing the User's Cashouts. | 
+**accounts** | **String** | URL of the endpoint describing the User's Accounts. | 
+**administered_platforms** | **String** | The platforms that this User is an Admin for. | 
+**cashout_available** | **String** | The dollar amount available for Cashout. | 
+**unpaid_income** | **String** | The dollar amount of Income not yet paid (Cashout/Rebate). | 
+**tax_savings** | **String** | URL for tax savings information for the given User. | 
+**platform** | **String** | URL of the platform that the User is contracting for. | 
+**platform_summary** | [**PlatformSummarySerializer**](PlatformSummarySerializer.md) |  | 
+**platform_membership_requests** | **String** | URL of the list of platform membership requests. | 
+**income_requests** | **String** | URL of the list of income requests. | 
+**is_platform_admin** | **String** | Flag specifying if the User has access to the Platform Admin UI. | 
+**has_password** | **String** | Flag specifying if the User has set their password. | 
+**cashout_fee_percent** | **String** | Percentage amount charged for each Cashout. | 
+**personal_information** | [**PersonalInformationSerializer**](PersonalInformationSerializer.md) |  | 
+**calculate_cashout_available** | **String** | Calculate what fees would be charged for a specific Cashout amount. | 
+**managers** | **Array<String>** |  | 
+
+