qwil_api 0.1.0

data/docs/IncomeApi.md

@@ -0,0 +1,98 @@
+# QwilAPI::IncomeApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**income_list**](IncomeApi.md#income_list) | **GET** /income/ | The list of Income items for all Users
+[**income_retrieve**](IncomeApi.md#income_retrieve) | **GET** /income/{pk}/ | The list of Income items for all Users
+
+
+# **income_list**
+> Array<IncomeSerializer> income_list
+
+The list of Income items for all Users
+
+The list of Income items for all Users.<br/>This can be filtered by date using the start_date and end_date query parameters.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::IncomeApi.new
+
+begin
+  #The list of Income items for all Users
+  result = api_instance.income_list
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling IncomeApi->income_list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;IncomeSerializer&gt;**](IncomeSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **income_retrieve**
+> IncomeSerializer income_retrieve(pk)
+
+The list of Income items for all Users
+
+The list of Income items for all Users.<br/>This can be filtered by date using the start_date and end_date query parameters.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::IncomeApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #The list of Income items for all Users
+  result = api_instance.income_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling IncomeApi->income_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**IncomeSerializer**](IncomeSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/IncomeNestedSerializer.md

@@ -0,0 +1,18 @@
+# QwilAPI::IncomeNestedSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**user** | **String** |  | 
+**amount** | **String** |  | 
+**platform** | **String** | The Platform that made this payment to the contractor | 
+**platform_name** | **String** |  | 
+**external_id** | **String** | Optional unique ID to correlate this Income to a record in another system. If specified, this will prevent duplicate Incomes being created with the same external_id. This field is unique per Platform. If this field is omitted, no uniqueness check is performed. | 
+**payment_time** | **DateTime** |  | 
+**notes** | **String** |  | 
+**imported_time** | **DateTime** |  | 
+**invoice** | **String** | The Invoice in which this Income is to be repaid by the platform. | 
+**rebate** | **String** | The Rebate in which this Income will be paid to the Contractor. | 
+
+

data/docs/IncomeSerializer.md

@@ -0,0 +1,18 @@
+# QwilAPI::IncomeSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**user** | **String** |  | 
+**amount** | **String** |  | 
+**platform** | **String** | The Platform that made this payment to the contractor | 
+**platform_name** | **String** |  | 
+**external_id** | **String** | Optional unique ID to correlate this Income to a record in another system. If specified, this will prevent duplicate Incomes being created with the same external_id. This field is unique per Platform. If this field is omitted, no uniqueness check is performed. | 
+**payment_time** | **DateTime** |  | 
+**notes** | **String** |  | 
+**imported_time** | **DateTime** |  | 
+**invoice** | **String** | The Invoice in which this Income is to be repaid by the platform. | 
+**rebate** | **String** | The Rebate in which this Income will be paid to the Contractor. | 
+
+

data/docs/IncomeSerializerFixedSource.md

@@ -0,0 +1,18 @@
+# QwilAPI::IncomeSerializerFixedSource
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**user** | **String** |  | 
+**amount** | **String** |  | 
+**platform** | **String** | The Platform that made this payment to the contractor | 
+**platform_name** | **String** |  | 
+**external_id** | **String** | Optional unique ID to correlate this Income to a record in another system. If specified, this will prevent duplicate Incomes being created with the same external_id. This field is unique per Platform. If this field is omitted, no uniqueness check is performed. | 
+**payment_time** | **DateTime** |  | 
+**notes** | **String** |  | 
+**imported_time** | **DateTime** |  | 
+**invoice** | **String** | The Invoice in which this Income is to be repaid by the platform. | 
+**rebate** | **String** | The Rebate in which this Income will be paid to the Contractor. | 
+
+

data/docs/InvoiceSerializer.md

@@ -0,0 +1,17 @@
+# QwilAPI::InvoiceSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**platform** | **String** | The Platform that is liable to pay this Invoice. | 
+**paid** | **BOOLEAN** | Flag specifying if the Invoice has been paid by the Platform. | 
+**payments** | **Array<String>** | The Cashouts that pay for this Invoice. | 
+**date** | **Date** | The date of the final day in the Invoice period. | 
+**contractor_payment_fee** | **String** | The total fee for Contractors billed this period. | 
+**per_user_charge** | **String** | The per-user charge for the period billed in this Invoice. | 
+**amount** | **String** |  | 
+**external_id** | **String** | Optional unique ID to correlate this Invoice to a record in another system. If specified, this will prevent duplicate Invoices being created with the same external_id. This field is unique per Platform. If this field is omitted, no uniqueness check is performed. | 
+**income** | **Array<String>** |  | 
+
+

data/docs/InvoiceSerializerFixedSourceCreate.md

@@ -0,0 +1,17 @@
+# QwilAPI::InvoiceSerializerFixedSourceCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**platform** | **String** | The Platform for this Invoice | 
+**paid** | **BOOLEAN** | Flag specifying if the Invoice has been paid by the Platform. | 
+**payments** | **Array<String>** | The Cashouts that pay for this Invoice. | 
+**date** | **Date** | The date of the final day in the Invoice period. | 
+**contractor_payment_fee** | **String** | The total fee for Contractors billed this period. | 
+**per_user_charge** | **String** | The per-user charge for the period billed in this Invoice. | 
+**amount** | **String** |  | 
+**external_id** | **String** | Optional unique ID to correlate this Invoice to a record in another system. If specified, this will prevent duplicate Invoices being created with the same external_id. This field is unique per Platform. If this field is omitted, no uniqueness check is performed. | 
+**income** | [**Array<IncomeNestedSerializer>**](IncomeNestedSerializer.md) |  | 
+
+

data/docs/InvoicesApi.md

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

data/docs/JSONWebTokenSerializer.md

@@ -0,0 +1,7 @@
+# QwilAPI::JSONWebTokenSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ManagerPlatformSerializer.md

@@ -0,0 +1,22 @@
+# QwilAPI::ManagerPlatformSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**name** | **String** |  | 
+**contact_information** | [**ContactInformationSerializer**](ContactInformationSerializer.md) |  | 
+**company_information** | [**CompanyInformationSerializer**](CompanyInformationSerializer.md) |  | 
+**contractors** | **String** |  | 
+**currency** | **String** | The ISO 4217 currency code for which all payments for this Platform are handled. Note: Immutable after Platform is created. | 
+**income** | **String** |  | 
+**invoices** | **String** |  | 
+**create_invoice** | **String** |  | 
+**payment_schedule** | **String** | The frequency of contractor rebates on this platform. | 
+**payment_date** | **Date** | The date that the first payment is due for the platform's pay cycle. | 
+**accounts** | **Array<String>** | The accounts configured for billing on this Platform. | 
+**default_account** | **String** | The account to use for billing purposes. | 
+**manager** | **String** |  | 
+**memberships** | **String** | URL of the list of Platform Memberships. | 
+
+

data/docs/ManagerSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::ManagerSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**name** | **String** |  | 
+**platforms** | **String** |  | 
+
+

data/docs/ManagersApi.md

@@ -0,0 +1,172 @@
+# QwilAPI::ManagersApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**manager_platform_create**](ManagersApi.md#manager_platform_create) | **POST** /managers/{manager_pk}/platforms/ | Endpoint for the Platforms owned by a Manager
+[**manager_platform_list**](ManagersApi.md#manager_platform_list) | **GET** /managers/{manager_pk}/platforms/ | Endpoint for the Platforms owned by a Manager
+[**manager_retrieve**](ManagersApi.md#manager_retrieve) | **GET** /managers/{pk}/ | Endpoint for Manager objects, which describe entities that can create and manage Platforms
+
+
+# **manager_platform_create**
+> ManagerPlatformSerializer manager_platform_create(manager_pk, name, company_information, opts)
+
+Endpoint for the Platforms owned by a Manager
+
+Endpoint for the Platforms owned by a Manager.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::ManagersApi.new
+
+manager_pk = "manager_pk_example" # String | 
+
+name = "name_example" # String | 
+
+company_information = "company_information_example" # String | 
+
+opts = { 
+  contact_information: "contact_information_example", # String | 
+  currency: "currency_example", # String | The ISO 4217 currency code for which all payments for this Platform are handled. Note: Immutable after Platform is created.
+  payment_schedule: "payment_schedule_example", # String | The frequency of contractor rebates on this platform.
+  payment_date: Date.parse("2013-10-20"), # Date | The date that the first payment is due for the platform's pay cycle.
+  accounts: "accounts_example", # String | The accounts configured for billing on this Platform.
+  default_account: "default_account_example" # String | The account to use for billing purposes.
+}
+
+begin
+  #Endpoint for the Platforms owned by a Manager
+  result = api_instance.manager_platform_create(manager_pk, name, company_information, opts)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling ManagersApi->manager_platform_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **manager_pk** | **String**|  | 
+ **name** | **String**|  | 
+ **company_information** | **String**|  | 
+ **contact_information** | **String**|  | [optional] 
+ **currency** | **String**| The ISO 4217 currency code for which all payments for this Platform are handled. Note: Immutable after Platform is created. | [optional] 
+ **payment_schedule** | **String**| The frequency of contractor rebates on this platform. | [optional] 
+ **payment_date** | **Date**| The date that the first payment is due for the platform's pay cycle. | [optional] 
+ **accounts** | **String**| The accounts configured for billing on this Platform. | [optional] 
+ **default_account** | **String**| The account to use for billing purposes. | [optional] 
+
+### Return type
+
+[**ManagerPlatformSerializer**](ManagerPlatformSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **manager_platform_list**
+> Array<ManagerPlatformSerializer> manager_platform_list(manager_pk)
+
+Endpoint for the Platforms owned by a Manager
+
+Endpoint for the Platforms owned by a Manager.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::ManagersApi.new
+
+manager_pk = "manager_pk_example" # String | 
+
+
+begin
+  #Endpoint for the Platforms owned by a Manager
+  result = api_instance.manager_platform_list(manager_pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling ManagersApi->manager_platform_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **manager_pk** | **String**|  | 
+
+### Return type
+
+[**Array<ManagerPlatformSerializer>**](ManagerPlatformSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **manager_retrieve**
+> ManagerSerializer manager_retrieve(pk)
+
+Endpoint for Manager objects, which describe entities that can create and manage Platforms
+
+Endpoint for Manager objects, which describe entities that can create and manage Platforms.
+
+### Example
+```ruby
+# load the gem
+require 'qwil_api'
+
+api_instance = QwilAPI::ManagersApi.new
+
+pk = "pk_example" # String | 
+
+
+begin
+  #Endpoint for Manager objects, which describe entities that can create and manage Platforms
+  result = api_instance.manager_retrieve(pk)
+  p result
+rescue QwilAPI::ApiError => e
+  puts "Exception when calling ManagersApi->manager_retrieve: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**ManagerSerializer**](ManagerSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/MembershipSerializer.md

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

data/docs/MembershipsApi.md

@@ -0,0 +1,56 @@
+# QwilAPI::MembershipsApi
+
+All URIs are relative to *http://localhost:8000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**membership_retrieve**](MembershipsApi.md#membership_retrieve) | **GET** /memberships/{pk}/ | 
+
+
+# **membership_retrieve**
+> MembershipSerializer membership_retrieve(pk)
+
+
+
+
+
+### Example
+```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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+
+### Return type
+
+[**MembershipSerializer**](MembershipSerializer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/PersonalInformationSerializer.md

@@ -0,0 +1,16 @@
+# QwilAPI::PersonalInformationSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_of_birth** | **Date** |  | 
+**address_city** | **String** |  | 
+**address_state** | **String** |  | 
+**tax_id_type** | **String** |  | 
+**phone_number** | **String** |  | 
+**address_zip_code** | **String** |  | 
+**tax_id_number** | **String** |  | 
+**address** | **String** |  | 
+**duns_number** | **String** | The Dun and Bradstreet number (D-U-N-S) for this entity | 
+
+

data/docs/PlaidPublicTokenSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::PlaidPublicTokenSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public_token** | **String** | A public_token generated by authenticating with Plaid Link. | 
+
+

data/docs/PlatformIncomeRequestSerializer.md

@@ -0,0 +1,15 @@
+# QwilAPI::PlatformIncomeRequestSerializer
+
+## 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 | 
+**user** | **String** | The User making the request for Income | 
+**income** | **String** | The resulting Income | 
+
+

data/docs/PlatformMembershipRequestSerializer.md

@@ -0,0 +1,11 @@
+# QwilAPI::PlatformMembershipRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**contractor** | [**ContractorSerializer**](ContractorSerializer.md) |  | 
+**actions** | **String** |  | 
+**status** | **String** | The status of the membership request. | 
+
+

data/docs/PlatformSerializer.md

@@ -0,0 +1,30 @@
+# QwilAPI::PlatformSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**contractors** | **String** |  | 
+**income** | **String** |  | 
+**invoices** | **String** |  | 
+**create_invoice** | **String** |  | 
+**membership_requests** | **String** | URL of the list of platform membership requests. | 
+**income_requests** | **String** | URL of the list of income requests. | 
+**memberships** | **String** | URL of the list of Platform Memberships. | 
+**name** | **String** |  | 
+**payment_schedule** | **String** | The frequency of contractor rebates on this platform. | 
+**payment_date** | **Date** | The date that the first payment is due for the platform's pay cycle. | 
+**automatic_debit** | **BOOLEAN** | Flag specifying if the Platform's Invoices should be debited automatically. | 
+**currency** | **String** | The ISO 4217 currency code for which all payments for this Platform are handled. Note: Immutable after Platform is created. | 
+**thumbnail_url** | **String** |  | 
+**validated** | **BOOLEAN** | If True, this platform is has been validated as a real company. | 
+**featured** | **BOOLEAN** | If True, this platform is featured in the search list. | 
+**is_demo_platform** | **BOOLEAN** | If True, all users on this platform are demo users, and no payments will be debited/credited. | 
+**xero_enabled** | **BOOLEAN** | If True, this platform can enable the Xero integration. | 
+**use_income_requests** | **BOOLEAN** | If True, enable experimental IncomeRequest UI for this User. | 
+**enable_emails** | **BOOLEAN** | Flag indicating if we should send any emails to Users on this Platform. If not set, email checks fall through to global defaults. | 
+**default_account** | **String** | The account to use for billing purposes. | 
+**manager** | **String** |  | 
+**accounts** | **Array<String>** | The accounts configured for billing on this Platform. | 
+
+

data/docs/PlatformSummarySerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::PlatformSummarySerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**name** | **String** |  | 
+**thumbnail_url** | **String** |  | 
+
+