qwil_api 0.1.0

data/docs/WriteAccountSerializer.md

@@ -0,0 +1,16 @@
+# QwilAPI::WriteAccountSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | [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] 
+
+

data/docs/WriteCashoutCalculationSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WriteCashoutCalculationSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The Cashout amount to calculate fees for. (This amount is net, i.e. before fees). | [optional] 
+
+

data/docs/WriteCashoutSerializer.md

@@ -0,0 +1,16 @@
+# QwilAPI::WriteCashoutSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** |  | 
+**cashout_time** | **DateTime** |  | [optional] 
+**notes** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**method** | **String** |  | [optional] 
+**transmit_time** | **DateTime** |  | [optional] 
+**user** | **String** |  | [optional] 
+**rebate** | **String** | The Rebate against which this Cashout will be collected. | [optional] 
+**account** | **String** |  | [optional] 
+
+

data/docs/WriteCashoutSliceSerializer.md

@@ -0,0 +1,11 @@
+# QwilAPI::WriteCashoutSliceSerializer
+
+## 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/WriteCompanyInformationSerializer.md

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

data/docs/WriteContactInfoSerializer.md

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

data/docs/WriteContactInformationSerializer.md

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

data/docs/WriteContractorSerializer.md

@@ -0,0 +1,14 @@
+# QwilAPI::WriteContractorSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**first_name** | **String** | First name, if the user is an individual. Leave blank if this user is a company. | [optional] 
+**last_name** | **String** | Last name, if the user is an individual. Leave blank if this user is a company. | [optional] 
+**business_name** | **String** | Business name. Only use this field if this user is a business entity. | [optional] 
+**contractor_type** | **String** |  | [optional] 
+**personal_information** | [**WritePersonalInformationSerializer**](WritePersonalInformationSerializer.md) |  | [optional] 
+**default_account** | **String** | Default account to use for payment of unpaid income. | [optional] 
+
+

data/docs/WriteIncomeNestedSerializer.md

@@ -0,0 +1,12 @@
+# QwilAPI::WriteIncomeNestedSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+**amount** | **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. | [optional] 
+**payment_time** | **DateTime** |  | [optional] 
+**notes** | **String** |  | [optional] 
+
+

data/docs/WriteIncomeSerializer.md

@@ -0,0 +1,13 @@
+# QwilAPI::WriteIncomeSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+**amount** | **String** |  | 
+**platform** | **String** | The Platform that made this payment to the contractor | 
+**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. | [optional] 
+**payment_time** | **DateTime** |  | [optional] 
+**notes** | **String** |  | [optional] 
+
+

data/docs/WriteIncomeSerializerFixedSource.md

@@ -0,0 +1,12 @@
+# QwilAPI::WriteIncomeSerializerFixedSource
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+**amount** | **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. | [optional] 
+**payment_time** | **DateTime** |  | [optional] 
+**notes** | **String** |  | [optional] 
+
+

data/docs/WriteInvoiceSerializer.md

@@ -0,0 +1,13 @@
+# QwilAPI::WriteInvoiceSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paid** | **BOOLEAN** | Flag specifying if the Invoice has been paid by the Platform. | [optional] 
+**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. | [optional] 
+**per_user_charge** | **String** | The per-user charge for the period billed in this Invoice. | [optional] 
+**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. | [optional] 
+
+

data/docs/WriteInvoiceSerializerFixedSourceCreate.md

@@ -0,0 +1,9 @@
+# QwilAPI::WriteInvoiceSerializerFixedSourceCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | [optional] 
+**income** | [**Array<IncomeNestedSerializer>**](IncomeNestedSerializer.md) |  | 
+
+

data/docs/WriteJSONWebTokenSerializer.md

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

data/docs/WriteManagerPlatformSerializer.md

@@ -0,0 +1,15 @@
+# QwilAPI::WriteManagerPlatformSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**contact_information** | [**ContactInformationSerializer**](ContactInformationSerializer.md) |  | [optional] 
+**company_information** | [**CompanyInformationSerializer**](CompanyInformationSerializer.md) |  | 
+**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** | **Array<String>** | The accounts configured for billing on this Platform. | [optional] 
+**default_account** | **String** | The account to use for billing purposes. | [optional] 
+
+

data/docs/WriteManagerSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WriteManagerSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+
+

data/docs/WriteMembershipSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WriteMembershipSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+
+

data/docs/WritePersonalInformationSerializer.md

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

data/docs/WritePlaidPublicTokenSerializer.md

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

data/docs/WritePlatformIncomeRequestSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::WritePlatformIncomeRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The dollar value of income requested by the User | 
+**note** | **String** | Text visible to the Platform and User describing the Income Request | [optional] 
+**user** | **String** | The User making the request for Income | 
+
+

data/docs/WritePlatformMembershipRequestSerializer.md

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

data/docs/WritePlatformSerializer.md

@@ -0,0 +1,19 @@
+# QwilAPI::WritePlatformSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**payment_date** | **Date** | The date that the first payment is due for the platform's pay cycle. | [optional] 
+**automatic_debit** | **BOOLEAN** | Flag specifying if the Platform's Invoices should be debited automatically. | [optional] 
+**thumbnail_url** | **String** |  | [optional] 
+**validated** | **BOOLEAN** | If True, this platform is has been validated as a real company. | [optional] 
+**featured** | **BOOLEAN** | If True, this platform is featured in the search list. | [optional] 
+**is_demo_platform** | **BOOLEAN** | If True, all users on this platform are demo users, and no payments will be debited/credited. | [optional] 
+**xero_enabled** | **BOOLEAN** | If True, this platform can enable the Xero integration. | [optional] 
+**use_income_requests** | **BOOLEAN** | If True, enable experimental IncomeRequest UI for this User. | [optional] 
+**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. | [optional] 
+**default_account** | **String** | The account to use for billing purposes. | [optional] 
+**accounts** | **Array<String>** | The accounts configured for billing on this Platform. | [optional] 
+
+

data/docs/WritePlatformSummarySerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WritePlatformSummarySerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+
+

data/docs/WriteRebateSerializer.md

@@ -0,0 +1,9 @@
+# QwilAPI::WriteRebateSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** |  | 
+**invoice** | **String** | The Invoice that will pay for this Rebate. | 
+
+

data/docs/WriteReceivablesSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WriteReceivablesSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** |  | 
+
+

data/docs/WriteTaxSavingsSerializer.md

@@ -0,0 +1,8 @@
+# QwilAPI::WriteTaxSavingsSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_savings_percent** | **String** | The percent of income to be withheld for tax savings purposes. | [optional] 
+
+

data/docs/WriteUserAccountSerializer.md

@@ -0,0 +1,14 @@
+# QwilAPI::WriteUserAccountSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | [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] 
+
+

data/docs/WriteUserCashoutSerializer.md

@@ -0,0 +1,15 @@
+# QwilAPI::WriteUserCashoutSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** |  | 
+**cashout_time** | **DateTime** |  | [optional] 
+**notes** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**method** | **String** |  | [optional] 
+**transmit_time** | **DateTime** |  | [optional] 
+**rebate** | **String** | The Rebate against which this Cashout will be collected. | [optional] 
+**account** | **String** |  | [optional] 
+
+

data/docs/WriteUserIncomeRequestSerializer.md

@@ -0,0 +1,10 @@
+# QwilAPI::WriteUserIncomeRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | The dollar value of income requested by the User | 
+**note** | **String** | Text visible to the Platform and User describing the Income Request | [optional] 
+**platform** | **String** | The platform that the User is requesting Income from. | 
+
+

data/docs/WriteUserPlatformMembershipRequestSerializer.md

@@ -0,0 +1,9 @@
+# QwilAPI::WriteUserPlatformMembershipRequestSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**decision_maker** | [**ContactInfoSerializer**](ContactInfoSerializer.md) |  | [optional] 
+**platform** | **String** | The platform that the User requests to join. | 
+
+

data/docs/WriteUserSerializer.md

@@ -0,0 +1,21 @@
+# QwilAPI::WriteUserSerializer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**first_name** | **String** | First name, if the user is an individual. Leave blank if this user is a company. | [optional] 
+**last_name** | **String** | Last name, if the user is an individual. Leave blank if this user is a company. | [optional] 
+**business_name** | **String** | Business name. Only use this field if this user is a business entity. | [optional] 
+**contractor_type** | **String** |  | [optional] 
+**default_account** | **String** | Default account to use for payment of unpaid income. | [optional] 
+**tax_savings_account** | **String** | Account to use for tax savings. | [optional] 
+**tax_savings_percent** | **String** | The percent of income to be withheld for tax savings purposes. | [optional] 
+**use_plaid** | **BOOLEAN** | Feature flag specifying if Plaid integration should be used. | [optional] 
+**use_income_requests** | **BOOLEAN** | Feature flag specifying if IncomeRequests should be enabled for this user. | [optional] 
+**use_tax_savings** | **BOOLEAN** | Feature flag specifying if tax savings should be enabled. | [optional] 
+**is_auto_cashout_enabled** | **BOOLEAN** | Whether or not all income should be immediately cashed out for this user. | [optional] 
+**password** | **String** |  | [optional] 
+**personal_information** | [**PersonalInformationSerializer**](PersonalInformationSerializer.md) |  | [optional] 
+
+

data/generate-client.sh

@@ -0,0 +1,6 @@
+for endpoint in api-token-auth managers platforms users accounts income invoices cashouts rebates memberships
+do
+    echo $endpoint
+    curl -so swagger-json/${endpoint}.json https://staging.qwil.co/docs/api-docs/${endpoint}
+    swagger-codegen generate -l ruby -i swagger-json/${endpoint}.json -o . -c swagger-codegen-config.json
+done